Copied!

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

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object.
    @type bool $allow_all_bundle_ids
          Optional. If set to true, allowed_bundle_ids are not enforced.
    @type array<string>|\Google\Protobuf\Internal\RepeatedField $allowed_bundle_ids
          Optional. iOS bundle ids of apps allowed to use the key.
          Example: 'com.companyname.productname.appname'
    @type \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId $apple_developer_id
          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.
    
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public clearAppleDeveloperId()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getAllowAllBundleIds()
 

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

Generated from protobuf field bool allow_all_bundle_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

  • return bool
public getAllowedBundleIds()
 

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

Example: 'com.companyname.productname.appname'

Generated from protobuf field repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL];

  • return \Google\Protobuf\Internal\RepeatedField
public 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.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL];

  • return \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId|null
public hasAppleDeveloperId()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setAllowAllBundleIds( $var)
 

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

Generated from protobuf field bool allow_all_bundle_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

  • param bool $var
  • return $this
public setAllowedBundleIds( $var)
 

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

Example: 'com.companyname.productname.appname'

Generated from protobuf field repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL];

  • param string[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setAppleDeveloperId( $var)
 

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.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL];

  • param \Google\Cloud\RecaptchaEnterprise\V1\AppleDeveloperId $var
  • return $this
Properties
protected $allow_all_bundle_ids = false
 

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

Generated from protobuf field bool allow_all_bundle_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

protected $apple_developer_id = NULL
 

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.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AppleDeveloperId apple_developer_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $allowed_bundle_ids = NULL
 

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

Example: 'com.companyname.productname.appname'

Generated from protobuf field repeated string allowed_bundle_ids = 1 [(.google.api.field_behavior) = OPTIONAL];

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration