identitytoolkit  v3
Public Member Functions | Static Public Member Functions | List of all members
google_identitytoolkit_api::Relyingparty Class Reference

#include <relyingparty.h>

Inheritance diagram for google_identitytoolkit_api::Relyingparty:

Public Member Functions

 Relyingparty (const Json::Value &storage)
 
 Relyingparty (Json::Value *storage)
 
virtual ~Relyingparty ()
 
const StringPiece GetTypeName () const
 
bool has_android_install_app () const
 
void clear_android_install_app ()
 
bool get_android_install_app () const
 
void set_android_install_app (bool value)
 
bool has_android_minimum_version () const
 
void clear_android_minimum_version ()
 
const StringPiece get_android_minimum_version () const
 
void set_android_minimum_version (const StringPiece &value)
 
bool has_android_package_name () const
 
void clear_android_package_name ()
 
const StringPiece get_android_package_name () const
 
void set_android_package_name (const StringPiece &value)
 
bool has_can_handle_code_in_app () const
 
void clear_can_handle_code_in_app ()
 
bool get_can_handle_code_in_app () const
 
void set_can_handle_code_in_app (bool value)
 
bool has_captcha_resp () const
 
void clear_captcha_resp ()
 
const StringPiece get_captcha_resp () const
 
void set_captcha_resp (const StringPiece &value)
 
bool has_challenge () const
 
void clear_challenge ()
 
const StringPiece get_challenge () const
 
void set_challenge (const StringPiece &value)
 
bool has_continue_url () const
 
void clear_continue_url ()
 
const StringPiece get_continue_url () const
 
void set_continue_url (const StringPiece &value)
 
bool has_email () const
 
void clear_email ()
 
const StringPiece get_email () const
 
void set_email (const StringPiece &value)
 
bool has_i_osa_pp_store_id () const
 
void clear_i_osa_pp_store_id ()
 
const StringPiece get_i_osa_pp_store_id () const
 
void set_i_osa_pp_store_id (const StringPiece &value)
 
bool has_i_osb_undle_id () const
 
void clear_i_osb_undle_id ()
 
const StringPiece get_i_osb_undle_id () const
 
void set_i_osb_undle_id (const StringPiece &value)
 
bool has_id_token () const
 
void clear_id_token ()
 
const StringPiece get_id_token () const
 
void set_id_token (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_new_email () const
 
void clear_new_email ()
 
const StringPiece get_new_email () const
 
void set_new_email (const StringPiece &value)
 
bool has_request_type () const
 
void clear_request_type ()
 
const StringPiece get_request_type () const
 
void set_request_type (const StringPiece &value)
 
bool has_user_ip () const
 
void clear_user_ip ()
 
const StringPiece get_user_ip () const
 
void set_user_ip (const StringPiece &value)
 

Static Public Member Functions

static RelyingpartyNew ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Relyingparty() [1/2]

google_identitytoolkit_api::Relyingparty::Relyingparty ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ Relyingparty() [2/2]

google_identitytoolkit_api::Relyingparty::Relyingparty ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~Relyingparty()

google_identitytoolkit_api::Relyingparty::~Relyingparty ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_android_install_app()

void google_identitytoolkit_api::Relyingparty::clear_android_install_app ( )
inline

Clears the 'androidInstallApp' attribute.

◆ clear_android_minimum_version()

void google_identitytoolkit_api::Relyingparty::clear_android_minimum_version ( )
inline

Clears the 'androidMinimumVersion' attribute.

◆ clear_android_package_name()

void google_identitytoolkit_api::Relyingparty::clear_android_package_name ( )
inline

Clears the 'androidPackageName' attribute.

◆ clear_can_handle_code_in_app()

void google_identitytoolkit_api::Relyingparty::clear_can_handle_code_in_app ( )
inline

Clears the 'canHandleCodeInApp' attribute.

◆ clear_captcha_resp()

void google_identitytoolkit_api::Relyingparty::clear_captcha_resp ( )
inline

Clears the 'captchaResp' attribute.

◆ clear_challenge()

void google_identitytoolkit_api::Relyingparty::clear_challenge ( )
inline

Clears the 'challenge' attribute.

◆ clear_continue_url()

void google_identitytoolkit_api::Relyingparty::clear_continue_url ( )
inline

Clears the 'continueUrl' attribute.

◆ clear_email()

void google_identitytoolkit_api::Relyingparty::clear_email ( )
inline

Clears the 'email' attribute.

◆ clear_i_osa_pp_store_id()

void google_identitytoolkit_api::Relyingparty::clear_i_osa_pp_store_id ( )
inline

Clears the 'iOSAppStoreId' attribute.

◆ clear_i_osb_undle_id()

void google_identitytoolkit_api::Relyingparty::clear_i_osb_undle_id ( )
inline

Clears the 'iOSBundleId' attribute.

◆ clear_id_token()

void google_identitytoolkit_api::Relyingparty::clear_id_token ( )
inline

Clears the 'idToken' attribute.

◆ clear_kind()

void google_identitytoolkit_api::Relyingparty::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_new_email()

void google_identitytoolkit_api::Relyingparty::clear_new_email ( )
inline

Clears the 'newEmail' attribute.

◆ clear_request_type()

void google_identitytoolkit_api::Relyingparty::clear_request_type ( )
inline

Clears the 'requestType' attribute.

◆ clear_user_ip()

void google_identitytoolkit_api::Relyingparty::clear_user_ip ( )
inline

Clears the 'userIp' attribute.

◆ get_android_install_app()

bool google_identitytoolkit_api::Relyingparty::get_android_install_app ( ) const
inline

Get the value of the 'androidInstallApp' attribute.

◆ get_android_minimum_version()

const StringPiece google_identitytoolkit_api::Relyingparty::get_android_minimum_version ( ) const
inline

Get the value of the 'androidMinimumVersion' attribute.

◆ get_android_package_name()

const StringPiece google_identitytoolkit_api::Relyingparty::get_android_package_name ( ) const
inline

Get the value of the 'androidPackageName' attribute.

◆ get_can_handle_code_in_app()

bool google_identitytoolkit_api::Relyingparty::get_can_handle_code_in_app ( ) const
inline

Get the value of the 'canHandleCodeInApp' attribute.

◆ get_captcha_resp()

const StringPiece google_identitytoolkit_api::Relyingparty::get_captcha_resp ( ) const
inline

Get the value of the 'captchaResp' attribute.

◆ get_challenge()

const StringPiece google_identitytoolkit_api::Relyingparty::get_challenge ( ) const
inline

Get the value of the 'challenge' attribute.

◆ get_continue_url()

const StringPiece google_identitytoolkit_api::Relyingparty::get_continue_url ( ) const
inline

Get the value of the 'continueUrl' attribute.

◆ get_email()

const StringPiece google_identitytoolkit_api::Relyingparty::get_email ( ) const
inline

Get the value of the 'email' attribute.

◆ get_i_osa_pp_store_id()

const StringPiece google_identitytoolkit_api::Relyingparty::get_i_osa_pp_store_id ( ) const
inline

Get the value of the 'iOSAppStoreId' attribute.

◆ get_i_osb_undle_id()

const StringPiece google_identitytoolkit_api::Relyingparty::get_i_osb_undle_id ( ) const
inline

Get the value of the 'iOSBundleId' attribute.

◆ get_id_token()

const StringPiece google_identitytoolkit_api::Relyingparty::get_id_token ( ) const
inline

Get the value of the 'idToken' attribute.

◆ get_kind()

const StringPiece google_identitytoolkit_api::Relyingparty::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_new_email()

const StringPiece google_identitytoolkit_api::Relyingparty::get_new_email ( ) const
inline

Get the value of the 'newEmail' attribute.

◆ get_request_type()

const StringPiece google_identitytoolkit_api::Relyingparty::get_request_type ( ) const
inline

Get the value of the 'requestType' attribute.

◆ get_user_ip()

const StringPiece google_identitytoolkit_api::Relyingparty::get_user_ip ( ) const
inline

Get the value of the 'userIp' attribute.

◆ GetTypeName()

const StringPiece google_identitytoolkit_api::Relyingparty::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_identitytoolkit_api::Relyingparty

◆ has_android_install_app()

bool google_identitytoolkit_api::Relyingparty::has_android_install_app ( ) const
inline

Determine if the 'androidInstallApp' attribute was set.

Returns
true if the 'androidInstallApp' attribute was set.

◆ has_android_minimum_version()

bool google_identitytoolkit_api::Relyingparty::has_android_minimum_version ( ) const
inline

Determine if the 'androidMinimumVersion' attribute was set.

Returns
true if the 'androidMinimumVersion' attribute was set.

◆ has_android_package_name()

bool google_identitytoolkit_api::Relyingparty::has_android_package_name ( ) const
inline

Determine if the 'androidPackageName' attribute was set.

Returns
true if the 'androidPackageName' attribute was set.

◆ has_can_handle_code_in_app()

bool google_identitytoolkit_api::Relyingparty::has_can_handle_code_in_app ( ) const
inline

Determine if the 'canHandleCodeInApp' attribute was set.

Returns
true if the 'canHandleCodeInApp' attribute was set.

◆ has_captcha_resp()

bool google_identitytoolkit_api::Relyingparty::has_captcha_resp ( ) const
inline

Determine if the 'captchaResp' attribute was set.

Returns
true if the 'captchaResp' attribute was set.

◆ has_challenge()

bool google_identitytoolkit_api::Relyingparty::has_challenge ( ) const
inline

Determine if the 'challenge' attribute was set.

Returns
true if the 'challenge' attribute was set.

◆ has_continue_url()

bool google_identitytoolkit_api::Relyingparty::has_continue_url ( ) const
inline

Determine if the 'continueUrl' attribute was set.

Returns
true if the 'continueUrl' attribute was set.

◆ has_email()

bool google_identitytoolkit_api::Relyingparty::has_email ( ) const
inline

Determine if the 'email' attribute was set.

Returns
true if the 'email' attribute was set.

◆ has_i_osa_pp_store_id()

bool google_identitytoolkit_api::Relyingparty::has_i_osa_pp_store_id ( ) const
inline

Determine if the 'iOSAppStoreId' attribute was set.

Returns
true if the 'iOSAppStoreId' attribute was set.

◆ has_i_osb_undle_id()

bool google_identitytoolkit_api::Relyingparty::has_i_osb_undle_id ( ) const
inline

Determine if the 'iOSBundleId' attribute was set.

Returns
true if the 'iOSBundleId' attribute was set.

◆ has_id_token()

bool google_identitytoolkit_api::Relyingparty::has_id_token ( ) const
inline

Determine if the 'idToken' attribute was set.

Returns
true if the 'idToken' attribute was set.

◆ has_kind()

bool google_identitytoolkit_api::Relyingparty::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_new_email()

bool google_identitytoolkit_api::Relyingparty::has_new_email ( ) const
inline

Determine if the 'newEmail' attribute was set.

Returns
true if the 'newEmail' attribute was set.

◆ has_request_type()

bool google_identitytoolkit_api::Relyingparty::has_request_type ( ) const
inline

Determine if the 'requestType' attribute was set.

Returns
true if the 'requestType' attribute was set.

◆ has_user_ip()

bool google_identitytoolkit_api::Relyingparty::has_user_ip ( ) const
inline

Determine if the 'userIp' attribute was set.

Returns
true if the 'userIp' attribute was set.

◆ New()

Relyingparty * google_identitytoolkit_api::Relyingparty::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_android_install_app()

void google_identitytoolkit_api::Relyingparty::set_android_install_app ( bool  value)
inline

Change the 'androidInstallApp' attribute.

whether or not to install the android app on the device where the link is opened.

Parameters
[in]valueThe new value.

◆ set_android_minimum_version()

void google_identitytoolkit_api::Relyingparty::set_android_minimum_version ( const StringPiece &  value)
inline

Change the 'androidMinimumVersion' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_android_package_name()

void google_identitytoolkit_api::Relyingparty::set_android_package_name ( const StringPiece &  value)
inline

Change the 'androidPackageName' attribute.

android package name of the android app to handle the action code.

Parameters
[in]valueThe new value.

◆ set_can_handle_code_in_app()

void google_identitytoolkit_api::Relyingparty::set_can_handle_code_in_app ( bool  value)
inline

Change the 'canHandleCodeInApp' attribute.

whether or not the app can handle the oob code without first going to web.

Parameters
[in]valueThe new value.

◆ set_captcha_resp()

void google_identitytoolkit_api::Relyingparty::set_captcha_resp ( const StringPiece &  value)
inline

Change the 'captchaResp' attribute.

The recaptcha response from the user.

Parameters
[in]valueThe new value.

◆ set_challenge()

void google_identitytoolkit_api::Relyingparty::set_challenge ( const StringPiece &  value)
inline

Change the 'challenge' attribute.

The recaptcha challenge presented to the user.

Parameters
[in]valueThe new value.

◆ set_continue_url()

void google_identitytoolkit_api::Relyingparty::set_continue_url ( const StringPiece &  value)
inline

Change the 'continueUrl' attribute.

The url to continue to the Gitkit app.

Parameters
[in]valueThe new value.

◆ set_email()

void google_identitytoolkit_api::Relyingparty::set_email ( const StringPiece &  value)
inline

Change the 'email' attribute.

The email of the user.

Parameters
[in]valueThe new value.

◆ set_i_osa_pp_store_id()

void google_identitytoolkit_api::Relyingparty::set_i_osa_pp_store_id ( const StringPiece &  value)
inline

Change the 'iOSAppStoreId' attribute.

iOS app store id to download the app if it's not already installed.

Parameters
[in]valueThe new value.

◆ set_i_osb_undle_id()

void google_identitytoolkit_api::Relyingparty::set_i_osb_undle_id ( const StringPiece &  value)
inline

Change the 'iOSBundleId' attribute.

the iOS bundle id of iOS app to handle the action code.

Parameters
[in]valueThe new value.

◆ set_id_token()

void google_identitytoolkit_api::Relyingparty::set_id_token ( const StringPiece &  value)
inline

Change the 'idToken' attribute.

The user's Gitkit login token for email change.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_identitytoolkit_api::Relyingparty::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

The fixed string "identitytoolkit#relyingparty".

Parameters
[in]valueThe new value.

◆ set_new_email()

void google_identitytoolkit_api::Relyingparty::set_new_email ( const StringPiece &  value)
inline

Change the 'newEmail' attribute.

The new email if the code is for email change.

Parameters
[in]valueThe new value.

◆ set_request_type()

void google_identitytoolkit_api::Relyingparty::set_request_type ( const StringPiece &  value)
inline

Change the 'requestType' attribute.

The request type.

Parameters
[in]valueThe new value.

◆ set_user_ip()

void google_identitytoolkit_api::Relyingparty::set_user_ip ( const StringPiece &  value)
inline

Change the 'userIp' attribute.

The IP address of the user.

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: