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



1607
1608
1609
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1607

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) 


1532
1533
1534
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1532

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) 


1539
1540
1541
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1539

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) 


1544
1545
1546
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1544

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) 


1549
1550
1551
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1549

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) 


1555
1556
1557
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1555

def captcha_resp
  @captcha_resp
end

#challenge ⇒ String

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

Returns:

  • (String) 


1560
1561
1562
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1560

def challenge
  @challenge
end

#continue_url ⇒ String

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

Returns:

  • (String) 


1565
1566
1567
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1565

def continue_url
  @continue_url
end

#email ⇒ String

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

Returns:

  • (String) 


1570
1571
1572
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1570

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) 


1575
1576
1577
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1575

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) 


1580
1581
1582
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1580

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) 


1585
1586
1587
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1585

def id_token
  @id_token
end

#kind ⇒ String

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

Returns:

  • (String) 


1590
1591
1592
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1590

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) 


1595
1596
1597
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1595

def new_email
  @new_email
end

#request_type ⇒ String

The request type. Corresponds to the JSON property requestType

Returns:

  • (String) 


1600
1601
1602
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1600

def request_type
  @request_type
end

#user_ip ⇒ String

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

Returns:

  • (String) 


1605
1606
1607
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1605

def user_ip
  @user_ip
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1612

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