Google Cloud Recaptcha Enterprise V1 Client - Class IOSKeySettings (2.3.0)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class IOSKeySettings.

Settings specific to keys that can be used by iOS apps.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.IOSKeySettings

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ allow_all_bundle_ids bool

Optional. If set to true, allowed_bundle_ids are not enforced.

↳ allowed_bundle_ids array

Optional. iOS bundle IDs of apps allowed to use the key. Example: 'com.companyname.productname.appname' Each key supports a maximum of 250 bundle IDs. To use a key on more apps, set allow_all_bundle_ids to true. When this is set, you are responsible for validating the bundle id by checking the token_properties.ios_bundle_id field in each assessment response against your list of allowed bundle IDs.

↳ apple_developer_id AppleDeveloperId

Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.

getAllowAllBundleIds

Optional. If set to true, allowed_bundle_ids are not enforced.

Returns
Type Description
bool

setAllowAllBundleIds

Optional. If set to true, allowed_bundle_ids are not enforced.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAllowedBundleIds

Optional. iOS bundle IDs of apps allowed to use the key.

Example: 'com.companyname.productname.appname' Each key supports a maximum of 250 bundle IDs. To use a key on more apps, set allow_all_bundle_ids to true. When this is set, you are responsible for validating the bundle id by checking the token_properties.ios_bundle_id field in each assessment response against your list of allowed bundle IDs.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAllowedBundleIds

Optional. iOS bundle IDs of apps allowed to use the key.

Example: 'com.companyname.productname.appname' Each key supports a maximum of 250 bundle IDs. To use a key on more apps, set allow_all_bundle_ids to true. When this is set, you are responsible for validating the bundle id by checking the token_properties.ios_bundle_id field in each assessment response against your list of allowed bundle IDs.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getAppleDeveloperId

Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.

Returns
Type Description
AppleDeveloperId|null

hasAppleDeveloperId

clearAppleDeveloperId

setAppleDeveloperId

Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app.

Parameter
Name Description
var AppleDeveloperId
Returns
Type Description
$this