Class: Google::Apis::IdentitytoolkitV3::Relyingparty
- Inherits:
-
Object
- Object
- Google::Apis::IdentitytoolkitV3::Relyingparty
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/identitytoolkit_v3/classes.rb,
lib/google/apis/identitytoolkit_v3/representations.rb,
lib/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.
Constructor Details
#initialize(**args) ⇒ Relyingparty
Returns a new instance of Relyingparty.
1780 1781 1782 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1780 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
1705 1706 1707 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1705 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
1712 1713 1714 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1712 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
1717 1718 1719 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1717 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
1722 1723 1724 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1722 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
1728 1729 1730 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1728 def captcha_resp @captcha_resp end |
#challenge ⇒ String
The recaptcha challenge presented to the user.
Corresponds to the JSON property challenge
1733 1734 1735 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1733 def challenge @challenge end |
#continue_url ⇒ String
The url to continue to the Gitkit app
Corresponds to the JSON property continueUrl
1738 1739 1740 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1738 def continue_url @continue_url end |
#email ⇒ String
The email of the user.
Corresponds to the JSON property email
1743 1744 1745 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1743 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
1748 1749 1750 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1748 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
1753 1754 1755 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1753 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
1758 1759 1760 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1758 def id_token @id_token end |
#kind ⇒ String
The fixed string "identitytoolkit#relyingparty".
Corresponds to the JSON property kind
1763 1764 1765 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1763 def kind @kind end |
#new_email ⇒ String
The new email if the code is for email change.
Corresponds to the JSON property newEmail
1768 1769 1770 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1768 def new_email @new_email end |
#request_type ⇒ String
The request type.
Corresponds to the JSON property requestType
1773 1774 1775 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1773 def request_type @request_type end |
#user_ip ⇒ String
The IP address of the user.
Corresponds to the JSON property userIp
1778 1779 1780 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1778 def user_ip @user_ip end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 1785 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 |