Usuário da classe
- java.lang.Object
-
- io.realm.mongodb.User
-
public class User extends Object
Um usuário mantém os metadados e tokens do usuário para acessar a funcionalidade do Aplicativo Realm.O usuário é usado para configurar Realms Sincronizados e dá acesso à chamada de Funções do Aplicativo de Realm por meio
Functions
e ao acesso remoto a reconhecimento de data center mongo do Aplicativo de Realm por meio de umMongoClient
.- Veja também:
App.login(Credentials)
,Builder(User, String)
-
-
Resumo da classe aninhada
Classes agrupadas Modificador e tipo classe Descrição static class
User.State
Os estados potenciais do usuário.
-
Resumo do método
Todos os métodos Métodos de instância Métodos concretos Modificador e tipo Método Descrição 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.String
getAccessToken()
Retorna o token de acesso atual para o usuário.ApiKeyAuth
getApiKeys()
Retorna um wrapper para gerenciar chaves de API controladas pelo usuário atual.App
getApp()
Retorna oApp
com o qual este usuário está associado.Document
getCustomData()
Retorne os dados de usuário personalizados associados ao usuário no aplicativo Realm.String
getDeviceId()
Retorna um identificador exclusivo para o dispositivo em que o usuário se conectou.Functions
getFunctions()
Retorna um gerenciador de Função de Realm para invocar Função de Realm do MongoDB Realm.Functions
getFunctions(CodecRegistry codecRegistry)
Retorna um gerenciador de funções para invocar Função de Realm com registro de codec personalizado para codificar e decodificar argumentos e resultados.String
getId()
Retorna o ID do servidor do usuário.List<UserIdentity>
getIdentities()
Retorna uma nova lista de identidades do usuário.MongoClient
getMongoClient(String serviceName)
Retorna uma instância doMongoClient
para acessar documento no reconhecimento de data center.UserProfile
getProfile()
Retorna o perfil deste usuário.Credentials.Provider
getProviderType()
Retorna o tipo de provedor usado para registrar o usuárioPush
getPush(String serviceName)
Gera a instânciaPush
para gerenciar registros de notificações push.String
getRefreshToken()
Retorna o token de atualização atual para o usuário.User.State
getState()
Retorna oUser.State
em que o usuário está.int
hashCode()
boolean
isLoggedIn()
Retorna verdadeiro se o usuário estiver conectado no momento.User
linkCredentials(Credentials credentials)
Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.RealmAsyncTask
linkCredentialsAsync(Credentials credentials, App.Callback<User> callback)
Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.void
logOut()
Desconecte o usuário do aplicativo Realm.RealmAsyncTask
logOutAsync(App.Callback<User> callback)
Desconecte o usuário do aplicativo Realm de forma assíncrona.Document
refreshCustomData()
Obtenha novamente dados de usuário personalizados no aplicativo Realm.RealmAsyncTask
refreshCustomData(App.Callback<Document> callback)
Buscar novamente dados de usuário personalizados do aplicativo Realm de forma assíncrona.User
remove()
Chamar isso removerá o usuário e quaisquer Realms que ele tenha do dispositivo.RealmAsyncTask
removeAsync(App.Callback<User> callback)
Chamar isso removerá assíncronamente o usuário e quaisquer Realms que o usuário tenha do dispositivo.
-
-
-
Detalhes do método
-
getId
string pública getId()
Retorna o ID do servidor do usuário.- Retorna:
- o ID do servidor do usuário.
-
Obter perfil
userProfile público getProfile ()
Retorna o perfil deste usuário.- Retorna:
- o perfil deste usuário
-
getIdentities
public List<UserIdentity> getIdentities()
Retorna uma nova lista de identidades do usuário.- Retorna:
- a lista de identidades.
- Veja também:
UserIdentity
-
getProviderType
public Credentials.Provider getProviderType()
Retorna o tipo de provedor usado para registrar o usuário- Retorna:
- o tipo de provedor do usuário
-
getAccessToken
string pública getAccessToken()
Retorna o token de acesso atual para o usuário.- Retorna:
- o token de acesso atual.
-
getRefreshToken
string pública getRefreshToken()
Retorna o token de atualização atual para o usuário.- Retorna:
- o token de atualização atual.
-
getDeviceId
string pública getDeviceId()
Retorna um identificador exclusivo para o dispositivo em que o usuário se conectou.- Retorna:
- um identificador de dispositivo exclusivo para o usuário.
-
getApp
aplicativo público getApp()
Retorna oApp
com o qual este usuário está associado.- Retorna:
- o
App
com o qual este usuário está associado.
-
Obter estado
public User.State getState()
Retorna oUser.State
em que o usuário está.- Retorna:
- o
User.State
do usuário.
-
getCustomData
documento público getCustomData()
Retorne os dados de usuário personalizados associados ao usuário no aplicativo Realm.Os dados só são atualizados quando o token de acesso do usuário é atualizado ou ao chamar explicitamente
refreshCustomData()
.- Retorna:
- Os dados de usuário personalizados associados ao usuário.
-
refreshCustomData
atualização do documento públicoCustomData()
Obtenha novamente dados de usuário personalizados no aplicativo Realm.- Retorna:
- Os dados de usuário personalizados atualizados associados ao usuário.
- Lançamentos:
AppException
- se a solicitação falhar de alguma forma.
-
refreshCustomData
public RealmAsyncTask refreshCustomData(App.Callback<Document> callback)
Buscar novamente dados de usuário personalizados 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.- Retorna:
- A tarefa que representa a operação contínua.
- Lançamentos:
IllegalStateException
- se não for chamado em um thread looper.
-
isLoggedIn
boolean público isLoggedIn()
Retorna verdadeiro se o usuário estiver conectado no momento. Retorna se esse usuário ainda está conectado ao aplicativo MongoDB Realm.- Retorna:
true
se ainda estiver conectado,false
caso contrário.
-
linkCredentials
linkCredentials de usuário público (credenciais de credenciais)
Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.Ao vincular um usuário com mais credenciais, 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.- Retorna:
- o
User
às credenciais estava vinculada. - Lançamentos:
IllegalStateException
- se nenhum usuário estiver conectado no momento.
-
linkCredentialsAsync
public RealmAsyncTask linkCredentialsAsync(Credentials credentials, App.Callback<User> callback)
Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.Ao vincular um usuário com mais credenciais, 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.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çamentos:
IllegalStateException
- se chamado de um thread não loop de eventos.
-
remover
O usuário público remove() lança AppException
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.- Retorna:
- o usuário que foi removido.
- Lançamentos:
AppException
- se ocorreu um erro ao tentar remover o usuário.
-
removeAsync
public RealmAsyncTask removeAsync(App.Callback<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çamentos:
IllegalStateException
- se chamado de um thread não loop de eventos.
-
sair
public void logOut() throws AppException
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. Todos os Realms de propriedade do usuário não serão excluídos do dispositivo antes queremove()
seja chamado.Após o aplicativo Realm confirmar o logout, qualquer
AuthenticationListener
registrado será notificado e as credenciais de usuário serão excluídas deste dispositivo.A saída de 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 porApp.allUsers()
. Eles podem ser removidos completamente chamandoremove()
.- Lançamentos:
AppException
- se ocorreu um erro ao tentar desconectar o usuário do aplicativo Realm.
-
logOutAsync
public RealmAsyncTask logOutAsync(App.Callback<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. Todos os Realms de propriedade do usuário não serão excluídos do dispositivo antes queremove()
seja chamado.Após o aplicativo Realm confirmar o logout, qualquer
AuthenticationListener
registrado será notificado e as credenciais de usuário serão excluídas deste dispositivo.A saída de 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 porApp.allUsers()
. Eles podem ser removidos completamente chamandoremove()
.- 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çamentos:
IllegalStateException
- se chamado de um thread não loop de eventos.
-
getApiKeys
public ApiKeyAuth getApiKeys()
Retorna um wrapper para gerenciar chaves de API controladas pelo usuário atual.- Retorna:
- wrapper para gerenciar chaves de API controladas pelo usuário atual.
- Lançamentos:
IllegalStateException
- se nenhum usuário estiver conectado no momento.
-
getFunctions
funções públicas getFunctions()
Retorna um gerenciador de Função de Realm para invocar Função de Realm do MongoDB Realm.Isso usará o registro de codecs padrão do aplicativo associado para codificar e decodificar argumentos e resultados.
- Veja também:
Functions
-
getFunctions
funções públicas getFunctions(CodecRegistry codecRegistry)
Retorna um gerenciador de funções para invocar Função de Realm 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.- Veja também:
Functions
-
getPush
push pública getPush(String serviceName)
Gera a instânciaPush
para gerenciar registros de notificações push.- Parâmetros:
serviceName
- o nome do serviço usado para se conectar ao servidor.
-
Cliente getMongoClient
Public MongoClient getMongoClient(String serviceName)
Retorna uma instância doMongoClient
para acessar documento no reconhecimento de data center.- Parâmetros:
serviceName
- o nome do serviço usado para se conectar ao servidor.
-
é igual a
boolean pública igual(@Nullable objeto o)
Dois usuários são considerados iguais se tiverem a mesma identidade de usuário e estiverem associados ao mesmo aplicativo.
-
-