Realm JavaScript

Aplicativo Realm~

A classe representa um aplicativo Atlas App Services.

let app = new Realm.App(config);

Classes relacionadas

sincronizar

Membros

allUsers

Retorna um dicionário de todos os usuários. A identidade dos usuários é usada como chave.

currentUser

Retorna o usuário atual, se houver.

emailPasswordAuth

Cliente para o provedor de autenticação por e-mail/senha.

Tipo:
Realm.Auth.EmailPasswordAuth
Exemplo:
{
// Creating a new user, by registering via email & password
const app = new Realm.App(config);
await app.emailPasswordAuth.registerUser({ email: 'john@example.com', password: 'some-secure-password' });
}

Constructor

nova aplicação(configOrId)

Cria um novo aplicativo e conecta-se a uma instância do Atlas App Services.

Parâmetros:
  • configOrId
    • Tipo: AppConfiguration ou string

    • A configuração do aplicativo ou um ID do aplicativo de string.

Lança:

  • Se nenhum ID do aplicativo for fornecido.

Métodos

addListener(chamada de resposta)

Adiciona um ouvinte que será acionado em vários eventos do usuário. Isso inclui login, logout, troca de usuários, vinculação de usuários e atualização de dados personalizados.

Parâmetros:
  • chamada de resposta
    • Tipo: function
deleteUser(usuário)Promise<void>

Exclui o usuário. OBSERVAÇÃO: isso exclui de forma irrecuperável o usuário do dispositivo e do servidor!

Parâmetros:
  • utilizador
Retorna: Promise<void>
getApp(appId)Realm.App

Retorna uma instância de um aplicativo. Se um aplicativo com o ID especificado não tiver sido criado, uma nova instância do aplicativo será criada.

Parâmetros:
  • appId
    • Tipo: string
Retorna: Realm.App
Desde: v10.0.0
login(credenciais)Promise<Realm.User>

Registra um usuário.

Parâmetros:
Retorna: Promise<Realm.User>
removeListener(chamada de resposta)

Remove um ouvinte de eventos (consulte addListener)

Parâmetros:
  • chamada de resposta
    • Tipo: function
removeListener()

Remove todos os ouvintes de eventos

removeUser(usuário)Promise<void>

Remove o usuário do cliente.

Parâmetros:
  • utilizador
Retorna: Promise<void>
switchUser(usuário)

Troca o usuário atual.

Parâmetros:
  • utilizador
    • Tipo: Realm.User

    • O usuário para o qual alternar.

Lança:

  • Se o usuário não estiver conectado.

Definições de tipo

AppConfiguration

Descreve as opções usadas para criar uma instância Realm.App .

Tipo:
Object
propriedades:
  • id
    • Tipo: string

    • A ID do aplicativo Atlas App Services.

  • URL base opcional
    • Tipo: string

    • A URL base do servidor Atlas App Services.

  • timeout opcional
    • Tipo: number

    • Tempo limite geral (em milissegundos) para solicitações.

  • baseFilePath opcional
    • Tipo: string

    • Especifique onde os domínios e metadados sincronizados são armazenados. Se não for especificado, o diretório de trabalho atual será usado.

LocalAppConfiguration

Descreve as opções usadas para a configuração do aplicativo local.

Tipo:
Object
propriedades:
  • name
    • Tipo: string

    • O nome do aplicativo.

  • Versão
    • Tipo: string

    • A versão do aplicativo.