realm::user 结构引用

#include <app.hpp>

公共类型
枚举类	state : uint8_t { logged_out , logged_in , removed }

公共成员函数
	user (const user &)=默认
	user ( user &&)=默认
用户&	操作符= (const user &)=默认
用户&	操作符= ( user &&)=默认
	user (std::shared_ptr< app::User > user )
bool	is_logged_in () const
std::string	identifier () const
州	state () const
std::string	access_token () const
std::string	refresh_token () const
structInternal::bridge::sync_manager	sync_manager () const
db_config	Flexible_sync_configuration () const
void	log_out (std::function< void(std::Optional< app_error >)> &&callback) const
std::future< void >	log_out () const
std::Optional< std::string >	custom_data () const
std::Optional< bsoncxx:: 文档 >	get_custom_data () const
void	call_function (const std::string &name, const std::string &args_ejson, std::function< void(std::Optional< std::string >, std::Optional< app_error >)> callback) const
std::future< std::Optional< std::string >>	call_function (const std::string &name, const std::string &args_ejson) const
void	call_function (const std::string &name, const std::vector< bsoncxx > &args_bson, std::function< void(std::Optional< bsoncxx >, std::Optional< app_error >)> callback) const
std::future< std::Optional< bsoncxx >>	call_function (const std::string &name, const std::vector< bsoncxx > &args_bson) const
void	refresh_custom_user_data (std::function< void(std::Optional< app_error >)> 回调)
std::future< void >	refresh_custom_user_data () const

公共属性
std::shared_ptr< app::User >	m_user

详细说明

一个User实例代表一个 Realm应用用户账户。

用户可能具有一个或多个与之关联的凭证。 这些凭证向身份验证提供者唯一标识用户，并用于登录 MongoDB Realm 用户帐户。

可以从任何线程访问用户对象。

成员枚举文档

状态

枚举 class 域::user::state : uint8_t

强

用户对象的状态。

成员函数文档

access_token()

std::string 域::user::access_token

(

)

const

用户用于访问 Realm 应用程序的刷新令牌。

这是向 MongoDB Realm 的 REST API 发出 HTTP 请求以获取原生未公开的功能所必需的。 应将其视为敏感数据。

call_function() [ 1 / 4 ]

std::future< std::Optional< std::string >> realm::user::call_function	(	const std::string &	名称，
		const std::string &	args_ejson
	)		const

使用提供的名称和参数调用 Atlas App Services 函数。

参数

名称	要调用的 Atlas App Services 函数的名称。
arguments	该字符串表示要提供给函数的扩展 json。

返回：

操作完成后，未来包含一个可选的 std::string。 此处理程序在调用方法的线程上执行。

call_function() [ 2 / 4 ]

void 域::user::call_function	(	const std::string &	名称，
		const std::string &	args_ejson ，
		std::function< void(std::Optional< std::string >, std::Optional< app_error >)>	callback
	)		const

使用提供的名称和参数调用 Atlas App Services 函数。

参数

名称	要调用的 Atlas App Services 函数的名称。
arguments	该字符串表示要提供给函数的扩展 json。
callback	函数调用完成时要调用的完成处理程序。 此处理程序在调用方法的线程上执行。

call_function() [ 3 / 4 ]

std::future< std::Optional< bsoncxx > > 域::user::call_function	(	const std::string &	名称，
		const std::vector< bsoncxx > &	args_bson
	)		const

使用提供的名称和参数调用 Atlas App Services 函数。

参数

名称	要调用的 Atlas App Services 函数的名称。
arguments	要提供给函数的 BSON 数组。

返回：

操作完成后，包含可选 BSON 的未来。

call_function() [ 4 / 4 ]

void 域::user::call_function	(	const std::string &	名称，
		const std::vector< bsoncxx > &	args_bson ，
		std::function< void(std::Optional< bsoncxx >, std::Optional< app_error >)>	callback
	)		const

使用提供的名称和参数调用 Atlas App Services 函数。

参数

名称	要调用的 Atlas App Services 函数的名称。
arguments	要提供给函数的 BSON 数组。
callback	函数调用完成时要调用的完成处理程序。 此处理程序在调用方法的线程上执行。

get_custom_data()

std::Optional< bsoncxx:: 文档 > 域::user::get_custom_data

(

)

const

用户的自定义数据。 这是在 Atlas App Services 应用程序中配置的。

identifier()

std::string realm::user::identifier

(

)

const

标识此用户的唯一 MongoDB Realm 字符串。 请注意，这与身份不同：用户可以具有多个身份，但只有一个标识符。 请参阅 RLMUserIdentity。

log_out()

void realm::user::log_out

(

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

callback

)

const

注销当前用户

如果用户是匿名用户，则用户状态将设置为Removed ；如果通过电子邮件/密码或第三方身份验证客户端进行身份验证，则状态将设置为LoggedOut 。如果注销请求失败，此方法仍将清除本地身份验证状态。

refresh_custom_user_data() [1/2]

std::future< void > 域::user::refresh_custom_user_data

(

)

const

刷新用户的自定义数据。 这实际上会刷新用户的身份验证会话。

refresh_custom_user_data() [2/2]

void realm::user::refresh_custom_user_data

(

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

callback

)

刷新用户的自定义数据。 这实际上会刷新用户的身份验证会话。

refresh_token()

std::string 域::user::refresh_token

(

)

const

用户用于访问 Realm 应用程序的刷新令牌。

这是向 Realm应用的 REST API 发出 HTTP 请求以获取原生未公开的功能所必需的。 应将其视为敏感数据。

state()

枚举user::state 域::user::state

(

)

const

用户的当前状态。

---

该结构体的文档由以下文件生成：

• include/cpprealm/ 应用.hpp
• src/cpprealm/app.cpp