Realm::user 構造体リファレンス

#include <app.hpp>

パブリックタイプ
列挙クラス	状態: uint8_t { loged_out , logged_in , delete }

パブリック メンバー関数
	user (const user &)=default
	user ( user &8)=default
user &	演算子= (const user &)=default
user &	Operator= ( user &=)=default
	user （std::shared_ptr< app::User > user ）
ブール	is_loged_in （）const
std::string	identifier () const
状態	状態（）const
std::string	access_token ()const
std::string	refresh_token ()const
struct internal::bridge::sync_manager	sync_manager ()const
db_config	pretty_sync_configuration ()const
void	log_out (std::function=oid(std::optional =app_error >)> &=colback)const
std::future< void >	log_out （）const
std::optional< std::string >	custom_data ()const
std::optional { bsoncx::document >	get_custom_data ()const
void	Call_function （const std::string &name、const std::string &args_ejson、std::function==id(std::optional=std::string >, std::optional< std::string > ==app_error========================================================
std::feature未満 std::optional{ std::string< std::string > > >	Call_function （const std::string &name、const std::string &args_ejson）const
void	Call_function （ const std::string &name、const std:: vector ===============================================================
std:: feature未満 std::optional	Call_function （const std::string &name、const std::vector< bsoncx > &args_bson）const
void	refresh_custom_user_data (std::function=double(std::optional =app_error >)> コールバック)
std::future< void >	refresh_custom_user_data ()const

パブリック属性
std::shared_ptr< app::User >	m_user

詳細な説明

Userインスタンスは、単一の Realmアプリユーザー アカウントを表します。

ユーザーは 1 つ以上の認証情報を関連付けることができます。 これらの認証情報は認証プロバイダーに対してユーザーを一意に識別し、MongoDB Realm ユーザー アカウントにサインインするために使用されます。

ユーザー オブジェクトには任意のスレッドからアクセスできます。

ノード列挙のドキュメント

列挙クラスRealm::user:: State : uint8_t

強力

ユーザー オブジェクトの状態。

メンバー関数のドキュメント

アクセストークン()

std::string Realm::user::access_token

(

)

制約

Realm アプリケーションにアクセスするために使用されるユーザーのリフレッシュ トークン。

これは、ネイティブに公開されていない機能に対して MongoDB Realm の REST API への HTTP リクエストを行うために必要です。 機密データとして扱う必要があります。

() [ 1 / 4 ]

std::feature< std::optional[ std::string]< std::string > > > Realm::user::Challenge_function	(	const std::string &	name,
		const std::string &	args_ejson
	)		制約

指定された名前と引数で Atlas App Services 関数を呼び出します。

パラメーター

name	呼び出される Atlas App Services 関数の名前。
arguments	stringは、関数に提供する拡張JSONを表しました。

戻り値

操作が完了すると、任意の std:string を含む未定義の std::string を含みます。 このハンドラーは、メソッドが呼び出されたスレッドで実行されます。

() [ 2 / 4 ]

無効邦土::user::呼び出す関数	(	const std::string &	name,
		const std::string &	args_ejson,
		std::function< void(std::optional< std::string >, std::optional< app_error >)>	コールバック
	)		制約

指定された名前と引数で Atlas App Services 関数を呼び出します。

パラメーター

name	呼び出される Atlas App Services 関数の名前。
arguments	stringは、関数に提供する拡張JSONを表しました。
コールバック	関数の呼び出しが完了したときに呼び出す完了ハンドラー。 このハンドラーは、メソッドが呼び出されたスレッドで実行されます。

() [ 3 / 4 ]

std:: feature未満 std::optional	(	const std::string &	name,
		const std::vector[ bsoncx] > &	args_bson
	)		制約

指定された名前と引数で Atlas App Services 関数を呼び出します。

パラメーター

name	呼び出される Atlas App Services 関数の名前。
arguments	関数に提供する BSON 配列。

戻り値

操作が完了すると、任意の BSON を含む将来の 。

() [ 4 / 4 ]

無効邦土::user::呼び出す関数	(	const std::string &	name,
		const std::vector[ bsoncx] > &	args_bson 、
		std::function< void(std::optional< bsoncxx >, std::optional< app_error >)>	コールバック
	)		制約

指定された名前と引数で Atlas App Services 関数を呼び出します。

パラメーター

name	呼び出される Atlas App Services 関数の名前。
arguments	関数に提供する BSON 配列。
コールバック	関数の呼び出しが完了したときに呼び出す完了ハンドラー。 このハンドラーは、メソッドが呼び出されたスレッドで実行されます。

get_custom_data()

std::optional"/ soncx::document /Realm::user::get_custom_data

(

)

制約

ユーザーのカスタム データ。 これは、Atlas App Services アプリで構成されます。

identifier()

std::string Realm::user::dentifier

(

)

制約

このユーザーを識別する一意の MongoDB Realm string。 これは ID とは異なることに注意してください。ユーザーは複数の ID を持っていても、識別子は 1 つだけです。 RLMuserIdentity を参照してください。

ログ ()

無効邦土::user::log_out

(

std::function< void(std::optional< app_error >)> &&

コールバック

)

制約

現在のユーザーをログアウトする

ユーザー状態は、匿名ユーザーの場合はRemoved 、またはメール／パスワードまたはサードパーティ認証クライアントによって認証されている場合はLoggedOutに設定されます。ログアウト リクエストが失敗した場合でも、このメソッドはローカル認証状態をクリアします。

" () [1/2]

< void >std::feature"Realm::user::refresh_custom_user_data

(

)

制約

ユーザーのカスタム データを更新します。 これにより、ユーザーの認証セッションが更新されます。

" () [2/2]

無効邦土::user::refresh_custom_user_data

(

std::function< void(std::optional< app_error >)>

コールバック

)

ユーザーのカスタム データを更新します。 これにより、ユーザーの認証セッションが更新されます。

* ()

std::stringrealm::user::refresh_token

(

)

制約

Realm アプリケーションにアクセスするために使用されるユーザーのリフレッシュ トークン。

これは、ネイティブに公開されていない機能に対して Realmアプリの REST API への HTTP リクエストを行うために必要です。 機密データとして扱う必要があります。

列挙user:: dateRealm::user:: State

(

)

制約

ユーザーの現在の状態。

---

この構造体のドキュメントは、次のファイルから生成されました。

• include/cpprealm/ app.happ
• src/cpprealm/app.cpp