Credenciais da Classe<PayloadType>

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

Parâmetros de tipo

  • payloadType estende SimpleObject = SimpleObject

hierarquia

  • Credenciais

Implementos

  • Credenciais<payloadType>

Construtores

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • type: "anon-user"
    • carga útil: AnonymousPayload

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • digite: "api-key"
    • carga útil: ApiKeyPayload

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • tipo: "local-userpass"
    • carga útil: EmailPasswordPayload

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • type: "custom-function"
    • carga útil: SimpleObject

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • type: "custom-token"
    • carga útil: JWTPayload

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • type: "oauth2-google"
    • carga útil: OAuth2RedirectPayload | GooglePayload

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • type: "oauth2-facebook"
    • carga útil: OAuth2RedirectPayload | FacebookPayload

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

  • Constrói uma instância de credenciais.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • nome: string
    • type: "oauth2-apple"
    • carga útil: OAuth2RedirectPayload | ApplePayload

      Os dados sendo enviados para o serviço durante a autenticação.

    Retorna Credenciais<payloadType>

Propriedades

Carga útil: payloadType

Os dados sendo enviados para o serviço durante a autenticação.

Nome do provedor: string

O nome do provedor de autenticação usado ao autenticar. Observação: é o mesmo que o tipo para todos os provedores de autenticação atuais no serviço e necessário principalmente para compatibilidade direta.

tipo de provedor: Tipo de provedor

O tipo do provedor de autenticação utilizado ao autenticar.

Métodos

  • Cria credenciais que iniciam sessão utilizando o Fornecedor de ID Apple.

    Parâmetros de tipo

    • payloadType estende OAuth2RedirectPayload | ApplePayload

    Parâmetros

    • redirectUrlOrIdToken: string

      A URL para a qual os usuários devem ser redirecionados ou o id_token retornado da Apple.

    Retorna Credenciais<payloadType>

    A instância de credenciais, que pode ser passada para app.logIn.

  • Parâmetros

    • carga útil: GoogleOptions

      A string de carga útil.

    Retorna SimpleObject

    Um objeto de carga útil com base na string.

  • Cria credenciais que fazem login usando o provedor de e-mail/senha. Observação: antigamente conhecido como o fornecedor "Nome de usuário/Senha".

    Parâmetros

    • e- mail: string

      O endereço de e-mail dos usuários finais.

    • senha: string

      A senha dos usuários finais.

    Retorna credenciais<EmailPasswordPayload>

    A instância de credenciais, que pode ser passada para app.logIn.

  • Cria credenciais que fazem login usando o provedor do Facebook.

    Parâmetros de tipo

    • payloadType estende OAuth2RedirectPayload | FacebookPayload

    Parâmetros

    • redirectUrlOrAccessToken: string

      A URL para a qual os usuários devem ser redirecionados ou o código de autenticação retornado do Facebook.

    Retorna Credenciais<payloadType>

    A instância de credenciais, que pode ser passada para app.logIn.

  • Cria credenciais que fazem login usando o Custom Function Provider.

    Parâmetros de tipo

    • payloadType estende SimpleObject = SimpleObject

    Parâmetros

    • payload: payloadType

      A carga personalizada conforme esperado pelo servidor.

    Retorna Credenciais<payloadType>

    A instância de credenciais, que pode ser passada para app.logIn.

  • Cria credenciais que fazem login usando o Google Provider.

    Parâmetros de tipo

    • P estende OAuth2RedirectPayload | GooglePayload

    Parâmetros

    • carga útil: GoogleOptions

      O URL para o qual os usuários devem ser redirecionados, o código de autenticação ou token de ID do Google.

    Retorna Credenciais<P>

    A instância de credenciais, que pode ser passada para app.logIn.

Gerado usando TypeDoc