Class: Google::Apis::IdentitytoolkitV3::Relyingparty
- Inherits:
-
Object
- Object
- Google::Apis::IdentitytoolkitV3::Relyingparty
- 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
-
#android_install_app ⇒ Boolean
(also: #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
. -
#android_minimum_version ⇒ String
minimum version of the app.
-
#android_package_name ⇒ String
android package name of the android app to handle the action code Corresponds to the JSON property
androidPackageName
. -
#can_handle_code_in_app ⇒ Boolean
(also: #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
. -
#captcha_resp ⇒ String
The recaptcha response from the user.
-
#challenge ⇒ String
The recaptcha challenge presented to the user.
-
#continue_url ⇒ String
The url to continue to the Gitkit app Corresponds to the JSON property
continueUrl
. -
#email ⇒ String
The email of the user.
-
#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
. -
#i_os_bundle_id ⇒ String
the iOS bundle id of iOS app to handle the action code Corresponds to the JSON property
iOSBundleId
. -
#id_token ⇒ String
The user's Gitkit login token for email change.
-
#kind ⇒ String
The fixed string "identitytoolkit#relyingparty".
-
#new_email ⇒ String
The new email if the code is for email change.
-
#request_type ⇒ String
The request type.
-
#user_ip ⇒ String
The IP address of the user.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Relyingparty
constructor
A new instance of Relyingparty.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Relyingparty
Returns a new instance of Relyingparty
1724 1725 1726 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1724 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
1649 1650 1651 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1649 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
1656 1657 1658 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1656 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
1661 1662 1663 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1661 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
1666 1667 1668 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1666 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
1672 1673 1674 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1672 def captcha_resp @captcha_resp end |
#challenge ⇒ String
The recaptcha challenge presented to the user.
Corresponds to the JSON property challenge
1677 1678 1679 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1677 def challenge @challenge end |
#continue_url ⇒ String
The url to continue to the Gitkit app
Corresponds to the JSON property continueUrl
1682 1683 1684 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1682 def continue_url @continue_url end |
#email ⇒ String
The email of the user.
Corresponds to the JSON property email
1687 1688 1689 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1687 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
1692 1693 1694 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1692 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
1697 1698 1699 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1697 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
1702 1703 1704 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1702 def id_token @id_token end |
#kind ⇒ String
The fixed string "identitytoolkit#relyingparty".
Corresponds to the JSON property kind
1707 1708 1709 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1707 def kind @kind end |
#new_email ⇒ String
The new email if the code is for email change.
Corresponds to the JSON property newEmail
1712 1713 1714 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1712 def new_email @new_email end |
#request_type ⇒ String
The request type.
Corresponds to the JSON property requestType
1717 1718 1719 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1717 def request_type @request_type end |
#user_ip ⇒ String
The IP address of the user.
Corresponds to the JSON property userIp
1722 1723 1724 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1722 def user_ip @user_ip end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 |
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1729 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 |