Class: Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TokenProperties

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/recaptchaenterprise_v1/classes.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb

Overview

Properties of the provided event token.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecaptchaenterpriseV1TokenProperties

Returns a new instance of GoogleCloudRecaptchaenterpriseV1TokenProperties.



1362
1363
1364
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1362

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#action ⇒ String

Action name provided at token generation. Corresponds to the JSON property action

Returns:

  • (String) 


1325
1326
1327
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1325

def action
  @action
end

#android_package_name ⇒ String

The name of the Android package with which the token was generated (Android keys only). Corresponds to the JSON property androidPackageName

Returns:

  • (String) 


1331
1332
1333
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1331

def android_package_name
  @android_package_name
end

#create_time ⇒ String

The timestamp corresponding to the generation of the token. Corresponds to the JSON property createTime

Returns:

  • (String) 


1336
1337
1338
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1336

def create_time
  @create_time
end

#hostname ⇒ String

The hostname of the page on which the token was generated (Web keys only). Corresponds to the JSON property hostname

Returns:

  • (String) 


1341
1342
1343
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1341

def hostname
  @hostname
end

#invalid_reason ⇒ String

Reason associated with the response when valid = false. Corresponds to the JSON property invalidReason

Returns:

  • (String) 


1346
1347
1348
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1346

def invalid_reason
  @invalid_reason
end

#ios_bundle_id ⇒ String

The ID of the iOS bundle with which the token was generated (iOS keys only). Corresponds to the JSON property iosBundleId

Returns:

  • (String) 


1351
1352
1353
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1351

def ios_bundle_id
  @ios_bundle_id
end

#valid ⇒ Boolean Also known as: valid?

Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment). Corresponds to the JSON property valid

Returns:

  • (Boolean) 


1359
1360
1361
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1359

def valid
  @valid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1367

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @android_package_name = args[:android_package_name] if args.key?(:android_package_name)
  @create_time = args[:create_time] if args.key?(:create_time)
  @hostname = args[:hostname] if args.key?(:hostname)
  @invalid_reason = args[:invalid_reason] if args.key?(:invalid_reason)
  @ios_bundle_id = args[:ios_bundle_id] if args.key?(:ios_bundle_id)
  @valid = args[:valid] if args.key?(:valid)
end