Aplicativo de classe<FunctionsFactoryType, CustomDataType>

Aplicativo Atlas App Services

Parâmetros de tipo

  • FunctionsFactoryType = Realm.DefaultFunctionsFactory & Realm.BaseFunctionsFactory

  • CustomDataType = SimpleObject

hierarquia

  • Aplicação

Implementos

  • Aplicação<FunçõesFactoryType, CustomDataType>

Construtores

  • Construa um aplicativo Realm , a partir da ID do aplicativo Realm visível na interface do usuário do Atlas App Services ou de uma configuração.

    Parâmetros de tipo

    • FunctionsFactoryType = DefaultFunctionsFactory eBaseFunctionsFactory

    • CustomDataType = SimpleObject

    Parâmetros

    • idOrConfiguration: string | AppConfiguration

      O ID do aplicativo Realm ou uma configuração a ser usada para esse aplicativo.

    Retorna o aplicativo<FunctionsFactoryType, CustomDataType>

Propriedades

_location URL: zero | Promessa<string> = nulo

Uma promessa que se resolve para o URL de localização do aplicativo.

autenticador: Autenticador

Autenticador interno usado para concluir solicitações de autenticação.

URL base: string

A URL base do aplicativo.

e-mailSenha Auth: EmailPasswordAuth

Herdar documento

buscador: Fetcher

Um objeto que pode ser usado para buscar respostas do servidor.

id: string

Herdar documento

aplicação local: Indefinido | LocalAppConfiguration

Configuração local do aplicativo. Útil para determinar qual nome e versão um usuário autenticado está executando.

Armazenamento: AppStorage

Armazenamento disponível para a aplicação.

Usuários: Usuário<FunçõesFactoryType, CustomDataType, DefaultUserProfileData>[] = []

Uma array de usuários ativos e desconectados. Os elementos no início da array são considerados mais recentes do que os elementos posteriores.

Credenciais: typeof Credenciais = Credenciais

As instâncias desta classe podem ser passadas para o método app.logIn para autenticar um usuário final.

appCache: {
    [ID: string]: App;
} = {}

Um mapa de instâncias de aplicativo retornadas da chamada de getApp.

Declaração de tipo

Acessores

  • get allUsers(): Readonly<Record<string, User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>>
  • Todos os usuários ativos e desconectados:

    • Em primeiro lugar na lista estão os usuários ativos (ordenados pela chamada mais recente para switchUser ou login)
    • seguido por usuários desconectados (também ordenados pela chamada mais recente para switchUser ou login).

    Retorna somente leitura<Record<string, User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>>

    Uma array de usuários ativos ou desconectados (o usuário atual é o primeiro).

  • obter usuário atual(): nulo | Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>
  • O usuário ativo atualmente (ou nulo se não existir nenhum usuário ativo).

    Returns null | User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    o usuário atualmente ativo ou nulo.

  • obter informações do dispositivo(): informações dodispositivo
  • Retorna DeviceInformation

    Informações sobre o dispositivo atual, enviadas ao servidor durante a autenticação.

  • obter localizaçãoUrl(): Promessa<string>
  • Retorna Promise<string>

    Uma promessa do URL do aplicativo , com a localização do aplicativo resolvida.

Métodos

  • Crie (e armazene) um novo usuário ou atualize o acesso de um usuário existente e atualize tokens. Isso ajuda a eliminar a duplicação de usuários na lista de usuários conhecidos do aplicativo.

    Parâmetros

    • resposta: AuthResponse

      Uma resposta do Autenticador.

    • providerType: ProviderType

      O tipo do fornecedor de autenticação utilizado.

    Returns User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    Um usuário novo ou existente.

  • Herdar documento

    Parâmetros

    • user: User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    Retorna a Promessa<null>

  • Restaura o estado do aplicativo (usuários ativos e desconectados) do armazenamento

    Retorna nulo

  • Conecte um usuário.

    Parâmetros

    • credenciais: Credenciais<SimpleObject>

      Credenciais para usar ao fazer login.

    • fetchProfile: boolean = true

      O perfil do usuário deve ser obtido? (padrão: verdadeiro)

    Returns Promise<User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>>

    Uma promessa resolvida para o usuário recém-conectado.

  • Herdar documento

    Parâmetros

    • user: User<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

    Retorna a Promessa<null>

  • Trocar de usuário.

    Parâmetros

    • NextUser: Usuário<FunctionsFactoryType, CustomDataType, DefaultUserProfileData>

      O usuário ou ID do usuário para o qual alternar.

    Retorna nulo

  • Obtenha ou crie um aplicativo Realm singleton 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

      A ID do aplicativo Realm visível na interface do usuário do Atlas App Services ou em uma configuração.

    Retorna o aplicativo<DefaultFunctionsFactory & BaseFunctionsFactory, SimpleObject>

    A instância do aplicativo Realm.

Gerado usando TypeDoc