Class: Google::Apis::IdentitytoolkitV3::Relyingparty

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

Overview

Request of getting a code for user confirmation (reset password, change email etc.)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Relyingparty

Returns a new instance of Relyingparty



1416
1417
1418
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1416

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

Instance Attribute Details

#android_install_app ⇒ Boolean Also known as: android_install_app?

whether or not to install the android app on the device where the link is opened Corresponds to the JSON property androidInstallApp

Returns:

  • (Boolean) 


1341
1342
1343
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1341

def android_install_app
  @android_install_app
end

#android_minimum_version ⇒ String

minimum version of the app. if the version on the device is lower than this version then the user is taken to the play store to upgrade the app Corresponds to the JSON property androidMinimumVersion

Returns:

  • (String) 


1348
1349
1350
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1348

def android_minimum_version
  @android_minimum_version
end

#android_package_name ⇒ String

android package name of the android app to handle the action code Corresponds to the JSON property androidPackageName

Returns:

  • (String) 


1353
1354
1355
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1353

def android_package_name
  @android_package_name
end

#can_handle_code_in_app ⇒ Boolean Also known as: can_handle_code_in_app?

whether or not the app can handle the oob code without first going to web Corresponds to the JSON property canHandleCodeInApp

Returns:

  • (Boolean) 


1358
1359
1360
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1358

def can_handle_code_in_app
  @can_handle_code_in_app
end

#captcha_resp ⇒ String

The recaptcha response from the user. Corresponds to the JSON property captchaResp

Returns:

  • (String) 


1364
1365
1366
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1364

def captcha_resp
  @captcha_resp
end

#challenge ⇒ String

The recaptcha challenge presented to the user. Corresponds to the JSON property challenge

Returns:

  • (String) 


1369
1370
1371
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1369

def challenge
  @challenge
end

#continue_url ⇒ String

The url to continue to the Gitkit app Corresponds to the JSON property continueUrl

Returns:

  • (String) 


1374
1375
1376
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1374

def continue_url
  @continue_url
end

#email ⇒ String

The email of the user. Corresponds to the JSON property email

Returns:

  • (String) 


1379
1380
1381
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1379

def email
  @email
end

#i_os_app_store_id ⇒ String

iOS app store id to download the app if it's not already installed Corresponds to the JSON property iOSAppStoreId

Returns:

  • (String) 


1384
1385
1386
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1384

def i_os_app_store_id
  @i_os_app_store_id
end

#i_os_bundle_id ⇒ String

the iOS bundle id of iOS app to handle the action code Corresponds to the JSON property iOSBundleId

Returns:

  • (String) 


1389
1390
1391
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1389

def i_os_bundle_id
  @i_os_bundle_id
end

#id_token ⇒ String

The user's Gitkit login token for email change. Corresponds to the JSON property idToken

Returns:

  • (String) 


1394
1395
1396
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1394

def id_token
  @id_token
end

#kind ⇒ String

The fixed string "identitytoolkit#relyingparty". Corresponds to the JSON property kind

Returns:

  • (String) 


1399
1400
1401
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1399

def kind
  @kind
end

#new_email ⇒ String

The new email if the code is for email change. Corresponds to the JSON property newEmail

Returns:

  • (String) 


1404
1405
1406
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1404

def new_email
  @new_email
end

#request_type ⇒ String

The request type. Corresponds to the JSON property requestType

Returns:

  • (String) 


1409
1410
1411
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1409

def request_type
  @request_type
end

#user_ip ⇒ String

The IP address of the user. Corresponds to the JSON property userIp

Returns:

  • (String) 


1414
1415
1416
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1414

def user_ip
  @user_ip
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1421

def update!(**args)
  @android_install_app = args[:android_install_app] if args.key?(:android_install_app)
  @android_minimum_version = args[:android_minimum_version] if args.key?(:android_minimum_version)
  @android_package_name = args[:android_package_name] if args.key?(:android_package_name)
  @can_handle_code_in_app = args[:can_handle_code_in_app] if args.key?(:can_handle_code_in_app)
  @captcha_resp = args[:captcha_resp] if args.key?(:captcha_resp)
  @challenge = args[:challenge] if args.key?(:challenge)
  @continue_url = args[:continue_url] if args.key?(:continue_url)
  @email = args[:email] if args.key?(:email)
  @i_os_app_store_id = args[:i_os_app_store_id] if args.key?(:i_os_app_store_id)
  @i_os_bundle_id = args[:i_os_bundle_id] if args.key?(:i_os_bundle_id)
  @id_token = args[:id_token] if args.key?(:id_token)
  @kind = args[:kind] if args.key?(:kind)
  @new_email = args[:new_email] if args.key?(:new_email)
  @request_type = args[:request_type] if args.key?(:request_type)
  @user_ip = args[:user_ip] if args.key?(:user_ip)
end