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



1631
1632
1633
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1631

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) 


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

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) 


1563
1564
1565
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1563

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) 


1568
1569
1570
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1568

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) 


1573
1574
1575
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1573

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) 


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

def captcha_resp
  @captcha_resp
end

#challenge ⇒ String

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

Returns:

  • (String) 


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

def challenge
  @challenge
end

#continue_url ⇒ String

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

Returns:

  • (String) 


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

def continue_url
  @continue_url
end

#email ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


1609
1610
1611
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1609

def id_token
  @id_token
end

#kind ⇒ String

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

Returns:

  • (String) 


1614
1615
1616
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1614

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) 


1619
1620
1621
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1619

def new_email
  @new_email
end

#request_type ⇒ String

The request type. Corresponds to the JSON property requestType

Returns:

  • (String) 


1624
1625
1626
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1624

def request_type
  @request_type
end

#user_ip ⇒ String

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

Returns:

  • (String) 


1629
1630
1631
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1629

def user_ip
  @user_ip
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1636

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