Usuário de classe<UserFunctionsFactoryType, UserCustomDataType, UserProfileDataType>

Representação de um usuário autenticado de um aplicativo.

Parâmetros de tipo

Construtores

Acessores

  • obter accessToken(): nulo | corda
  • O token de acesso usado ao solicitar um novo token de acesso.

    Retorna nulo | corda

    O token de acesso como uma string ou null.

  • obtenha apiKeys(): ApiKeyAuth
  • Execute operações relacionadas ao provedor de autenticação da chave de API.

    Retorna ApiKeyAuth

    Um objeto ApiKeyAuth que pode ser usado para managed chaves de API.

  • get customData(): UserCustomDataType
  • Você pode armazenar dados arbitrários sobre os usuários da aplicação em uma collection MongoDB e configurar o Atlas App Services para expor automaticamente os dados de cada usuário em um campo de seu objeto de usuário. Por exemplo, você pode armazenar o idioma preferido do usuário, a data de nascimento ou o fuso horário local.

    Se este valor não tiver sido configurado, estará vazio.

    Retorna UserCustomDataType

    Os dados personalizados como um objeto.

  • get deviceId(): nulo | corda
  • O ID do dispositivo.

    Retorna nulo | corda

    O ID do dispositivo como uma string ou null.

  • get ID(): string
  • O ID interno gerado automaticamente do usuário.

    Retorna a string

    O ID do usuário como uma string.

  • obter identidades(): UserIdentity[]
  • As identidades do usuário em qualquer um dos provedor de autenticação do aplicativo.

    Retorna a identidade do usuário[]

    Uma array de objetos UserIdentity .

  • get isLoggedIn(): booleano
  • O estado conectado do usuário.

    Retorna booleano

    true se o usuário estiver conectado, false caso contrário.

  • obter perfil(): UserProfileDataType
  • Um perfil contendo informações adicionais sobre o usuário.

    Retorna UserProfileDataType

    Os dados do perfil do usuário como um objeto.

  • get providerType(): ProviderType
  • O tipo de provedor usado ao autenticar o usuário. Se existirem várias identidades, o tipo de fornecedor para a primeira identidade encontrada será retornada.

    retorna ProviderType

    O tipo de provedor como uma string enumerada.

    Obsoleto(a)

    Em vez disso, use identidades .

  • obter atualizaçãoToken(): nulo | corda
  • O token de atualização usado ao solicitar um novo token de acesso.

    Retorna nulo | corda

    O token de atualização como uma string ou null.

  • obter estado(): UserState
  • O estado do usuário.

    Retorna o estado do usuário

    O estado como uma string enumerada.

Métodos

  • Adiciona um ouvinte que será acionado em vários eventos relacionados ao usuário. Isso inclui atualização do token de autenticação, atualização do token de atualização, atualização de dados de usuário personalizados e logout.

    Parâmetros

    • chamada de resposta: UserChangeCallback

      A chamada de resposta a ser acionada quando o evento ocorrer.

    Retorna nulo

  • Chame uma função remota do Atlas App Services por seu nome.

    Parâmetros

    • nome: string

      Nome da função do App Services.

    • Rest ...argumentos: desconhecido[]

      Argumentos passados para a função .

    Retorna a Promessa<desconhecido>

    Uma promessa que se resolve para o valor retornado pela Função.

    Observação

    Considere usar functions[name]() em vez de chamar este método.

    Exemplo

    // These are all equivalent:
    await user.callFunction("doThing", a1, a2, a3);
    await user.functions.doThing(a1, a2, a3);
    await user.functions["doThing"](a1, a2, a3);

    Exemplo

    // The methods returned from the functions object are bound, which is why it's okay to store the function in a variable before calling it:
    const doThing = user.functions.doThing;
    await doThing(a1);
    await doThing(a2);
  • Vincule o usuário com uma identidade representada por outro conjunto de credenciais.

    Parâmetros

    Retorna a Promessa<null>

    Uma promessa que é resolvida assim que o usuário for vinculado às credenciais.

  • Desconecte o usuário.

    Retorna a Promessa<null>

    Uma promessa que é resolvida assim que o usuário for desconectado do aplicativo.

  • Parâmetros

    • serviceName: string

      O nome do serviço MongoDB ao qual se conectar.

    Retorna MongoDBService

    Um cliente habilitando acesso a um serviço MongoDB.

    Exemplo

    let blueWidgets = user.mongoClient("myService")
    .db("myDb")
    .collection<Widget>("widgets")
    .find({ color: "blue" });
  • Atualize o token de acesso e obtenha dados personalizados dele.

    Retorna a promessa<UserCustomDataType>

    Uma promessa que se resolve nos dados personalizados atualizados.

  • Remove todos os ouvintes de eventos adicionados anteriormente via User.addListener.

    Retorna nulo

  • Remove um ouvinte de eventos adicionado anteriormente via User.addListener.

    Parâmetros

    Retorna nulo

Gerado usando TypeDoc