Copied!

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

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object.
    @type bool $allow_all_package_names
          Optional. If set to true, allowed_package_names are not enforced.
    @type array<string>|\Google\Protobuf\Internal\RepeatedField $allowed_package_names
          Optional. Android package names of apps allowed to use the key.
          Example: 'com.companyname.appname'
    @type bool $support_non_google_app_store_distribution
          Optional. Set to true for keys that are used in an Android application that
          is available for download in app stores in addition to the Google Play
          Store.
    
    }
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 Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getAllowAllPackageNames()
 

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

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

  • return bool
public getAllowedPackageNames()
 

Optional. Android package names of apps allowed to use the key.

Example: 'com.companyname.appname'

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

  • return \Google\Protobuf\Internal\RepeatedField
public getSupportNonGoogleAppStoreDistribution()
 

Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.

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

  • return bool
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 setAllowAllPackageNames( $var)
 

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

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

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

Optional. Android package names of apps allowed to use the key.

Example: 'com.companyname.appname'

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

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

Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.

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

  • param bool $var
  • return $this
Properties
protected $allow_all_package_names = false
 

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

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

protected $support_non_google_app_store_distribution = false
 

Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.

Generated from protobuf field bool support_non_google_app_store_distribution = 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_package_names = NULL
 

Optional. Android package names of apps allowed to use the key.

Example: 'com.companyname.appname'

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

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration