Usuário da classe

Os Atlas Device SDKs estão obsoletos. Consulte apágina de descontinuação do para detalhes.

io.realm.mongodb

java.lang.Object

io.realm.mongodb.User

Um usuário mantém os metadados e tokens do usuário para acessar a funcionalidade do aplicativo Realm usuário é usado para configurar Realms sincronizados e fornece acesso para chamar funções do aplicativo Realm por meio de funções e acessar o aplicativo Realm remoto

Bancos de dadosmongo por meio de um MongoClient .

Dica

Veja também:

App.login(Credentials)
io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(Usuário, string)

Resumo da classe aninhada

Modificador e tipo	Classe e descrição
`public static final`	User.State

Resumo do método

Modificador e tipo	Método e descrição
booleanopúblico	equals ( Object o ) Dois usuários são considerados iguais se tiverem a mesma identidade de usuário e estiverem associados ao mesmo aplicativo.
string pública	getAccessToken () Retorna o token de acesso atual para o usuário.
ApiKeyAuthpúblico sincronizado	getApiKeys () Retorna um wrapper para gerenciar chaves de API controladas pelo usuário atual.
aplicativopúblico	getApp () Retorna o aplicativo ao qual este usuário está associado.
Documentopúblico	getCustomData () Retorne os dados de usuário personalizados associados ao usuário no aplicativo Realm.
string pública	getDeviceId () Retorna um identificador exclusivo para o dispositivo em que o usuário se conectou.
funçõespúblicas	getFunctions ( CodecRegistry codecRegistry ) Retorna um gerenciador de funções para Realm funções de domínio com registro de codec personalizado para codificar e decodificar argumentos e resultados.
public synchronized Functions	getFunctions () Retorna um gerenciador de funções para invocar funções do MongoDB Realm.
string pública	getId () Retorna o ID do servidor do usuário.
lista pública	getIdentities () Retorna uma nova lista de identidades do usuário.
MongoClientsincronizado público	getMongoClient ( String serviceName ) Retorna uma instância MongoClient para acessar documentos no banco de banco de dados.
UserProfilepúblico	getProfile () Retorna o perfil deste usuário.
Credentials.Providerpúblico	getProviderType () Retorna o tipo de provedor usado para registrar o usuário
public synchronized Push	getPush ( String serviceName ) Retorna a instância Push para gerenciar registros de notificação push.
string pública	getRefreshToken () Retorna o token de atualização atual para o usuário.
user.Statepúblico	getState () Retorna o estado em que o usuário está.
public int	hashCode ()
booleanopúblico	isLoggedIn () Retorna verdadeiro se o usuário estiver conectado no momento.
usuáriopúblico	linkCredentials ( Credentials credentials ) Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.
RealmAsyncTaskpúblico	linkCredentialsAsync ( Credentials credentials, io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.
public void	logOut () Desconecte o usuário do aplicativo Realm.
RealmAsyncTaskpúblico	logOutAsync ( io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Desconecte o usuário do aplicativo Realm de forma assíncrona.
RealmAsyncTaskpúblico	refreshCustomData ( io.realm.mongodb.App.Callback<Document> callback ) Buscar novamente dados de usuário personalizados do aplicativo Realm de forma assíncrona.
Documentopúblico	refreshCustomData () Obtenha novamente dados de usuário personalizados no aplicativo Realm.
usuáriopúblico	remove () Chamar isso removerá o usuário e quaisquer Realms que ele tenha do dispositivo.
RealmAsyncTaskpúblico	removeAsync ( io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Chamar isso removerá assíncronamente o usuário e quaisquer Realms que o usuário tenha do dispositivo.

Métodos herdados

Métodos herdados da classe java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Detalhes do método

é igual a

public boolean equals ( Object o )
Dois usuários são considerados iguais se tiverem a mesma identidade de usuário e estiverem associados ao mesmo aplicativo. Substitui `equals` no objeto de classe

getAccessToken

public String getAccessToken ()
Retorna o token de acesso atual para o usuário. Devoluções o token de acesso atual.

getApiKeys

public synchronized ApiKeyAuth getApiKeys ()
Retorna um wrapper para gerenciar chaves de API controladas pelo usuário atual. Devoluções wrapper para gerenciar chaves de API controladas pelo usuário atual. Lança Exceção de estado ilegal - se nenhum usuário estiver conectado no momento.

getApp

public App getApp ()
Retorna o aplicativo ao qual este usuário está associado. Devoluções o aplicativo ao qual esse usuário está associado.

getCustomData

public Document getCustomData ()
Retorne os dados de usuário personalizado associados ao usuário no aplicativo Realm dados só são atualizados quando o token de acesso do usuário é atualizado ou ao chamar explicitamente refreshCustomData() . Devoluções Os dados de usuário personalizados associados ao usuário.

getDeviceId

public String getDeviceId ()
Retorna um identificador exclusivo para o dispositivo em que o usuário se conectou. Devoluções um identificador de dispositivo exclusivo para o usuário.

getFunctions

public Functions getFunctions ( CodecRegistry codecRegistry )
Retorna um gerenciador de funções para Realm funções de domínio com registro de codec personalizado para codificar e decodificar argumentos e resultados. Parâmetros `codecRegistry` - O registro de codec a ser usado para codificar e decodificar argumentos e resultados para o aplicativo Realm remoto. Dica Veja também: Funções

public synchronized Functions getFunctions ()
Retorna um gerenciador de funções para invocar funções do MongoDB Realm. Isso usará o registro de codec padrão do aplicativo associado para codificar e decodificar argumentos e resultados. Dica Veja também: Funções

getId

public String getId ()
Retorna o ID do servidor do usuário. Devoluções o ID do servidor do usuário.

getIdentities

public List getIdentities ()
Retorna uma nova lista de identidades do usuário. Devoluções a lista de identidades. Dica Veja também: UserIdentity

Cliente getMongoClient

public synchronized MongoClient getMongoClient ( String serviceName )
Retorna uma instância MongoClient para acessar documentos no banco de banco de dados. Parâmetros `serviceName` - o nome do serviço usado para se conectar ao servidor.

Obter perfil

public UserProfile getProfile ()
Retorna o perfil deste usuário. Devoluções o perfil deste usuário

getProviderType

public Credentials.Provider getProviderType ()
Retorna o tipo de provedor usado para registrar o usuário Devoluções o tipo de provedor do usuário

getPush

public synchronized Push getPush ( String serviceName )
Retorna a instância Push para gerenciar registros de notificação push. Parâmetros `serviceName` - o nome do serviço usado para se conectar ao servidor.

getRefreshToken

public String getRefreshToken ()
Retorna o token de atualização atual para o usuário. Devoluções o token de atualização atual.

Obter estado

public User.State getState ()
Retorna o estado em que o usuário está. Devoluções o estado do usuário.

hashCode

public int hashCode ()
Substitui `hashCode` no objeto de classe

isLoggedIn

public boolean isLoggedIn ()
Retorna verdadeiro se o usuário estiver conectado no momento. Retorna se esse usuário ainda está conectado ao aplicativo MongoDB Realm. Devoluções `true` se ainda estiver conectado, `false` caso contrário.

linkCredentials

public User linkCredentials (

Credentials credentials

)

Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.Vincular um usuário com mais credenciais, significa que o usuário pode fazer login em qualquer uma dessas credenciais. Também torna possível "atualizar" um usuário anônimo vinculando-o, por exemplo, Credenciais de e-mail/senha.

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

Nota: Não é possível vincular dois usuários existentes do MongoDB Realm. As credenciais fornecidas não devem ter sido usadas por outro usuário.

Parâmetros

credentials - as credenciais para vincular ao usuário atual.

Devoluções

o usuário ao qual as credenciais estavam vinculadas.

Lança

Exceção de estado ilegal - se nenhum usuário estiver conectado no momento.

linkCredentialsAsync

public RealmAsyncTask linkCredentialsAsync (

Credentials credentials,

io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback

)

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

Nota: Não é possível vincular dois usuários existentes do MongoDB Realm. As credenciais fornecidas não devem ter sido usadas por outro usuário.

Parâmetros

credentials - as credenciais para vincular ao usuário atual.
callback - chamada de resposta quando as identidades do usuário tiverem sido vinculadas ou falharem. A chamada de resposta sempre acontecerá no mesmo thread em que este método é chamado.

Lança

Exceção de estado ilegal - se chamado de um thread não looper.

sair

public void logOut ()

Desconecte o usuário do aplicativo Realm . Isso cancelará o registro deles no dispositivo e interromperá qualquer sincronização de e para os Realms dos usuários. Quaisquer Realms de propriedade do usuário não serão excluídos do dispositivo antes que User.remove() seja chamado.

Depois que o aplicativo Realm confirmar o logout, qualquer AuthenticationListener registrado será notificado e as credenciais de usuário serão excluídas deste dispositivo.

Desconectar usuários anônimos os removerá imediatamente em vez de marcá-los como User.State.LOGGED_OUT .

Todos os outros usuários serão marcados como User.State.LOGGED_OUT e ainda serão retornados por App.allUsers() . Eles podem ser removidos completamente chamando User.remove() .

Lança

AppException - se ocorrer um erro ao tentar desconectar o usuário do aplicativo Realm.

logOutAsync

public RealmAsyncTask logOutAsync (

io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback

)

Desconecte o usuário do aplicativo Realm de forma assíncrona. Isso cancelará o registro deles no dispositivo e interromperá qualquer sincronização de e para os Realms dos usuários. Quaisquer Realms de propriedade do usuário não serão excluídos do dispositivo antes que User.remove() seja chamado.

Depois que o aplicativo Realm confirmar o logout, qualquer AuthenticationListener registrado será notificado e as credenciais de usuário serão excluídas deste dispositivo.

Desconectar usuários anônimos os removerá imediatamente em vez de marcá-los como User.State.LOGGED_OUT .

Todos os outros usuários serão marcados como User.State.LOGGED_OUT e ainda serão retornados por App.allUsers() . Eles podem ser removidos completamente chamando User.remove() .

Parâmetros

callback - chamada de resposta quando o encerramento da sessão for concluído ou falhar. A chamada de resposta sempre acontecerá no mesmo thread em que este método é chamado.

Lança

Exceção de estado ilegal - se chamado de um thread não looper.

refreshCustomData

public RealmAsyncTask refreshCustomData (

io.realm.mongodb.App.Callback<Document> callback

)

Buscar novamente dados de usuário personalizado do aplicativo Realm de forma assíncrona.Esta é a variante assíncrona de refreshCustomData() .

Parâmetros

callback - A chamada de resposta que receberá o resultado ou quaisquer erros da solicitação.

Devoluções

A tarefa que representa a operação contínua.

Lança

Exceção de estado ilegal - se não for chamado em uma thread looper.

public Document refreshCustomData ()
Obtenha novamente dados de usuário personalizados no aplicativo Realm. Devoluções Os dados de usuário personalizados atualizados associados ao usuário. Lança AppException - se a solicitação falhar de alguma forma.

remover

public User remove ()
Chamar isso removerá o usuário e quaisquer Realms que ele tenha do dispositivo. Nenhum dado é removido do servidor. Se o usuário estiver conectado ao chamar esse método, o usuário será desconectado antes que todos os dados sejam excluídos. Devoluções o usuário que foi removido. Lança AppException - se ocorrer um erro ao tentar remover o usuário.

removeAsync

public RealmAsyncTask removeAsync (

io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback

)

Chamar isso removerá assíncronamente o usuário e quaisquer Realms que o usuário tenha do dispositivo. Nenhum dado é removido do servidor. Se o usuário estiver conectado ao chamar esse método, o usuário será desconectado antes que todos os dados sejam excluídos.

Parâmetros

callback - chamada de resposta quando a remoção do usuário for concluída ou falhar. A chamada de resposta sempre acontecerá no mesmo thread em que este método é chamado.

Lança

Exceção de estado ilegal - se chamado de um thread não looper.

Voltar

RealmResultTask

User.State