Aplicativo de classe<FunctionsFactoryType, CustomDataType>

A classe representa um aplicativo Atlas App Services.

const app = new App({ id: "my-app-qwert" });

Parâmetros de tipo

FunçõesFactoryType estende DefaultFunctionsFactory = DefaultFunctionsFactory
CustomDataType estende DefaultObject = DefaultObject

Index

Construtores

construtor

nova aplicação<FunçõesFactoryType, CustomDataType>(id): export=.Aplicação<FunçõesFactoryType, CustomDataType>
Constrói uma nova instância de App , usada para se conectar a um Atlas App Services.
Parâmetros de tipo
- FunçõesFactoryType estende DefaultFunctionsFactory = DefaultFunctionsFactory
- CustomDataType estende DefaultObject = DefaultObject
Parâmetros
- ID: string
  Um ID do aplicativo de string.
Retorna export=.App<FunctionsFactoryType, CustomDataType>
Lança
um erro se nenhum ID for fornecido.
- Definido em pacotes/realm/src/app-services/App.ts:250
nova aplicação<FunçõesFactoryType, CustomDataType>(config): export=.Aplicação<FunçõesFactoryType, CustomDataType>
Constrói uma nova instância de App , usada para se conectar a um Atlas App Services.
Parâmetros de tipo
- FunçõesFactoryType estende DefaultFunctionsFactory = DefaultFunctionsFactory
- CustomDataType estende DefaultObject = DefaultObject
Parâmetros
- config: AppConfiguration
  A configuração do aplicativo.
Retorna export=.App<FunctionsFactoryType, CustomDataType>
Lança
um erro se nenhum ID do aplicativo for fornecido.
- Definido em pacotes/realm/src/app-services/App.ts:257

Acessores

todos osusuários

get allUsers(): Readonly<Registro<string, Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>>
Todos os usuários que fizeram login no dispositivo e não foram removidos.

Retorna somente leitura<Registro<string, Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>>
Um mapeamento do ID do usuário para o usuário.
- Definido em pacotes/realm/src/app-services/App.ts:343

usuário atual

get currentUser : nulo | _ Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>
O último usuário a fazer login ou para o qual está sendo alternado.

Retorna nulo | Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>
Um objeto de usuário representando o usuário atualmente conectado. Se nenhum usuário estiver conectado, null será retornado.
- Definido em pacotes/realm/src/app-services/App.ts:334

e-mailSenha Auth

get emailPasswordAuth(): EmailPasswordAuth
Execute operações relacionadas ao provedor de autenticação de e-mail/senha.

Retorna EmailPasswordAuth
Uma instância do provedor de autenticação de senha de e-mail.
- Definido em pacotes/realm/src/app-services/App.ts:324

id

get ID(): string
Retorna a string
O ID do aplicativo.
- Definido em pacotes/realm/src/app-services/App.ts:305

Métodos

adicionar ouvinte

adicionar ouvinte(chamada de resposta): vazio
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
- retorno de chamada: AppChangeCallback
  Uma função de chamada de resposta que será chamada quando o evento ocorrer.
Retorna nulo
- Definido em pacotes/realm/src/app-services/App.ts:378

excluirusuário

excluirusuário(utilizador): Promessa<vazio>
Exclua o usuário. OBSERVAÇÃO: isso exclui de forma irrecuperável o usuário do dispositivo e do servidor!
Parâmetros
- usuário: AnyUser
Retorna a Promessa<null>
Uma promessa que se resolve assim que o usuário for excluído.
- Definido em pacotes/realm/src/app-services/App.ts:369

Conecte-se

Conecte-se(credenciais): Promessa<Usuário<FunçõesFactoryType, CustomDataType, DefaultUserProfileData>>
Conecte um usuário.
Parâmetros
- credenciais: export=.Credenciais
  Um objeto de credenciais descrevendo o tipo de provedor de autenticação e seus parâmetros.
Retorna Promessa<Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>
Uma promessa que é resolvida para o usuário conectado.

Lança
Um erro se o login falhar.
- Definido em pacotes/realm/src/app-services/App.ts:315

removertodosos ouvintes

removertodosos ouvintes(): vazio
Remove todos os ouvintes de eventos adicionados anteriormente via App.addListener.

Retorna nulo
- Definido em pacotes/realm/src/app-services/App.ts:393

removerouvinte

removerouvinte(chamada de resposta): vazio
Remove um ouvinte de eventos adicionado anteriormente via App.addListener.
Parâmetros
- retorno de chamada: AppChangeCallback
  A chamada de resposta a ser removida.
Retorna nulo
- Definido em pacote/Realm/src/app-services/App.ts:386

removerusuário

removerusuário(utilizador): Promessa<vazio>
Desconecta e remove um usuário do cliente.
Parâmetros
- usuário: AnyUser
Retorna a Promessa<null>
Uma promessa que se resolve assim que o usuário for desconectado e removido do aplicativo.
- Definido em pacote/Realm/src/app-services/App.ts:360

trocar de usuário

trocar de usuário(utilizador): vazio
Troca o usuário atual para o especificado em user.
Parâmetros
- usuário: AnyUser
  O usuário para o qual alternar.
Retorna nulo
Lança
um erro se o novo usuário for desconectado ou removido.
- Definido em pacotes/realm/src/app-services/App.ts:352

`Static` obter

obter(id): export=.Aplicação<DefaultFunctionsFactory, Objeto padrão>
Obtenha ou crie um aplicativo Realm único a partir de um ID. Chamar esta função várias vezes com o mesmo ID retornará a mesma instância.
Parâmetros
- ID: string
  O ID do aplicativo Realm visível na interface do usuário do Atlas App Services ou em uma configuração.
Retorna export=.App<DefaultFunctionsFactory, DefaultObject>
A instância do aplicativo Realm.
- Definido em pacote/Realm/src/app-services/App.ts:204

`Static` obtenhao aplicativo

obtenhao aplicativo(id): export=.Aplicação<DefaultFunctionsFactory, Objeto padrão>
Obtenha ou crie um aplicativo Realm único a partir de um ID. Chamar esta função várias vezes com o mesmo ID retornará a mesma instância.
Parâmetros
- ID: string
  O ID do aplicativo Realm visível na interface do usuário do Atlas App Services ou em uma configuração.
Retorna export=.App<DefaultFunctionsFactory, DefaultObject>
A instância do aplicativo Realm.

Obsoleto(a)
Use o App.get.
- Definido em pacote/Realm/src/app-services/App.ts:194

Aplicativo de classe<FunctionsFactoryType, CustomDataType>

Parâmetros de tipo

FunçõesFactoryType estende DefaultFunctionsFactory = DefaultFunctionsFactory

CustomDataType estende DefaultObject = DefaultObject

Index

Construtores

Acessores

Métodos

Construtores

construtor

Parâmetros de tipo

FunçõesFactoryType estende DefaultFunctionsFactory = DefaultFunctionsFactory

CustomDataType estende DefaultObject = DefaultObject

Parâmetros

ID: string

Retorna export=.App<FunctionsFactoryType, CustomDataType>

Lança

Parâmetros de tipo

FunçõesFactoryType estende DefaultFunctionsFactory = DefaultFunctionsFactory

CustomDataType estende DefaultObject = DefaultObject

Parâmetros

config: AppConfiguration

Retorna export=.App<FunctionsFactoryType, CustomDataType>

Lança

Acessores

todos osusuários

Retorna somente leitura<Registro<string, Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>>

usuário atual

Retorna nulo | Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

e-mailSenha Auth

Retorna EmailPasswordAuth

id

Retorna a string

Métodos

adicionar ouvinte

Parâmetros

retorno de chamada: AppChangeCallback

Retorna nulo

excluirusuário

Parâmetros

usuário: AnyUser

Retorna a Promessa<null>

Conecte-se

Parâmetros

credenciais: export=.Credenciais

Retorna Promessa<Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

Lança

removertodosos ouvintes

Retorna nulo

removerouvinte

Parâmetros

retorno de chamada: AppChangeCallback

Retorna nulo

removerusuário

Parâmetros

usuário: AnyUser

Retorna a Promessa<null>

trocar de usuário

Parâmetros

usuário: AnyUser

Retorna nulo

Lança

Static obter

Parâmetros

ID: string

Retorna export=.App<DefaultFunctionsFactory, DefaultObject>

Static obtenhao aplicativo

Parâmetros

ID: string

Retorna export=.App<DefaultFunctionsFactory, DefaultObject>

Obsoleto(a)

Configurações

Visibilidade do membro

Tema

Nesta página

`Static` obter

`Static` obtenhao aplicativo