Referência de estrutura Realm::user

#include <app.hpp>

Tipos públicos
Classe de enumeração	estado : uint8_t { conectado_out, conectado_em , removido }

Funções de membro público
	user (const user &)=default
	usuário (usuário &&)=padrão
user &	operator= (const user &)=default
user &	operador= (usuário &&)=padrão
	usuário (std::shared_ptr < app::usuário >< app::User > usuário)
bool	is_logged_in () const
std::string	identificador () const
state	estado () const
std::string	access_token () const
std::string	refresh_token () const
struct initial::bridge::sync_manager	sync_manager () const
db_config	flexible_sync_configuration () const
vazio	log_out (std::function<void(std::optional< app_error >)> &&callback) const
std::future< void >	log_out () const
std::opcional< std::string >	custom_data () const
std::opcional < bsoncxx::document >	get_custom_data () const
vazio	call_function (const std::string &name, const std::string &args_ejson, std::function< vazio(std::opcional< std::string >, std::opcional< app_error >)> chamada de resposta) const
std::future< std::optional< std::string > >	call_function (const std::string &name, const std::string &args_ejson) const
vazio	chamada de resposta ) const
std::future< std::opcional< bsoncxx > >	call_function (const std::string &name, const std::vector< bsoncxx > &args_bson) const
vazio	refresh_custom_user_data (std::function<void(std::optional< app_error >)> chamada de resposta)
std::future< void >	refresh_custom_user_data () const

Atributos públicos
std::shared_ptr< app::User >	m_user

Descrição detalhada

Uma instância User representa uma única conta de usuário do aplicativo Realm.

Um usuário pode ter uma ou mais credenciais associadas a ele. Essas credenciais identificam exclusivamente o usuário para o provedor de autenticação e são usadas para fazer login em uma conta de usuário do MongoDB Realm.

Objeto de usuário podem ser acessados de qualquer thread.

Documentação de enumeração de membros

estado

enumeração class Realm::user::state : uint8_t

forte

O estado do objeto do usuário.

Documentação da função do membro

access_token()

std::string Realm::user::access_token

(

)

const

O token de atualização do usuário usado para acessar o aplicativo Realm.

Isso é necessário para fazer solicitações HTTP à REST API do MongoDB Realm para funcionalidades não expostas de forma nativa. Devem ser tratados como dados confidenciais.

call_function() [1/4]

std::future< std::optional< std::string > > Realm::user::call_function	(	const std::string &	name,
		const std::string &	args_ejson
	)		const

Chama a função Atlas App Services com o nome e os argumentos fornecidos.

Parâmetros

name	O nome da função Atlas App Services a ser chamada.
argumentos	A string representa o JSON estendido para ser fornecido à função.

Devoluções

Um futuro contendo um std::string opcional assim que a operação for concluída. Esse manipulador é executado no thread do qual o método foi chamado.

call_function() [2/4]

vazio Realm::user::call_function	(	const std::string &	name,
		const std::string &	args_ejson,
		std::function< vazio(std::opcional< std::string >, std::opcional< app_error >)>	chamada de resposta
	)		const

Chama a função Atlas App Services com o nome e os argumentos fornecidos.

Parâmetros

name	O nome da função Atlas App Services a ser chamada.
argumentos	A string representa o JSON estendido para ser fornecido à função.
chamada de resposta	O manipulador de conclusão para chamar quando a chamada de função estiver concluída. Esse manipulador é executado na thread da qual o método foi chamado.

call_function() [3/4]

std::future< std::optional< bsoncxx > > Realm::user::call_function	(	const std::string &	name,
		const std::vector < bsoncxx > &	args_bson
	)		const

Chama a função Atlas App Services com o nome e os argumentos fornecidos.

Parâmetros

name	O nome da função Atlas App Services a ser chamada.
argumentos	A array BSON a ser fornecida à função.

Devoluções

Um futuro contendo BSON opcional assim que a operação for concluída.

call_function() [4/4]

vazio Realm::user::call_function	(	const std::string &	name,
		const std::vector < bsoncxx > &	args_bson,
		std::function < vazio(std::opcional < bsoncxx >, std::opcional < app_error >)>	chamada de resposta
	)		const

Chama a função Atlas App Services com o nome e os argumentos fornecidos.

Parâmetros

name	O nome da função Atlas App Services a ser chamada.
argumentos	A array BSON a ser fornecida à função.
chamada de resposta	O manipulador de conclusão para chamar quando a chamada de função estiver concluída. Esse manipulador é executado na thread da qual o método foi chamado.

get_custom_data()

std::opcional< bsoncxx::documento > Realm::user::get_custom_data

(

)

const

Os dados personalizados do usuário. Isso é configurado em seu aplicativo Atlas App Services.

identificador()

std::string Realm::user::identifier

(

)

const

A sequência exclusiva do MongoDB Realm que identifica esse usuário. Observe que isso é diferente de uma identidade: um usuário pode ter várias identidades, mas tem um único identificador. Consulte RLMUserIdentity.

log_out()

vazio Realm::user::log_out

(

std::function< vazio(std::opcional< app_error >)> &&

chamada de resposta

)

const

Desconecta o usuário atual

O estado dos usuários será definido como Removed se for um usuário anônimo ou LoggedOut se for autenticado por um e-mail/senha ou clientes de autenticação de terceiros Se a solicitação de logout falhar, esse método ainda limpará o estado da autenticação local.

refresh_custom_user_data() [1/2]

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

(

)

const

Refresh a user's custom data. Isso, de fato, atualizará a sessão de autenticação do usuário.

refresh_custom_user_data() [2/2]

void realm::user::refresh_custom_user_data

(

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

chamada de resposta

)

Refresh a user's custom data. Isso, de fato, atualizará a sessão de autenticação do usuário.

refresh_token()

std::string Realm::user::refresh_token

(

)

const

O token de atualização do usuário usado para acessar o aplicativo Realm.

Isso é necessário para fazer solicitações HTTP à REST API do aplicativo Realm para funcionalidades não expostas de forma nativa. Devem ser tratados como dados confidenciais.

estado()

enumeração user::state Realm::user::state

(

)

const

O estado atual do usuário.

---

A documentação para esta estrutura foi gerada a partir dos seguintes arquivos:

• include/cprealm/app.hpp
• src/cprealm/app.cpp