identity namespace

Funções

Função Descrição
beforeOperation(eventType, optsOrHandler, manipulador)
beforeUserCreated(manipulador) Lida com um evento que é acionado antes de um usuário ser criado.
beforeUserCreated(opções, manipulador) Lida com um evento que é acionado antes de um usuário ser criado.
beforeUserSignedIn(manipulador) Lida com um evento que é acionado antes de um usuário entrar.
beforeUserSignedIn(opções, manipulador) Lida com um evento que é acionado antes de um usuário entrar.
getOpts(opções de bloqueio)

Aulas

Aula Descrição
Erro HTTPS Um erro explícito que pode ser gerado por um manipulador para enviar um erro ao cliente que chamou a função.

Interfaces

Interface Descrição
Evento AuthBlocking Define o evento de autenticação para eventos de bloqueio de 2ª geração
AuthUserRecord O UserRecord passado para funções de bloqueio de autenticação da plataforma de identidade.
Opções de bloqueio Todas as opções de função mais idToken, accessToken e refreshToken.

identidade.beforeOperation()

Assinatura:

export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>), handler: (event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;

Parâmetros

Parâmetro Tipo Descrição
tipo de evento AuthBlockingEventType
optsOrHandler Opções de bloqueio | ((evento: AuthBlockingEvent ) => BeforeCreateResponse | AntesSignInResponse | vazio | Promessa<BeforeCreateResponse> | Promessa<BeforeSignInResponse> | Promessa<void>)
manipulador (evento: AuthBlockingEvent ) => BeforeCreateResponse | AntesSignInResponse | vazio | Promessa<BeforeCreateResponse> | Promessa<BeforeSignInResponse> | Promessa<void>

Retorna:

Função de bloqueio

identidade.beforeUserCreated()

Lida com um evento que é acionado antes de um usuário ser criado.

Assinatura:

export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

Parâmetros

Parâmetro Tipo Descrição
manipulador (evento: AuthBlockingEvent ) => BeforeCreateResponse | Promessa<BeforeCreateResponse> | vazio | Promessa<void> Manipulador de eventos que é executado sempre antes de um usuário ser criado

Retorna:

Função de bloqueio

identidade.beforeUserCreated()

Lida com um evento que é acionado antes de um usuário ser criado.

Assinatura:

export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

Parâmetros

Parâmetro Tipo Descrição
opta Opções de bloqueio Objeto contendo opções de função
manipulador (evento: AuthBlockingEvent ) => BeforeCreateResponse | Promessa<BeforeCreateResponse> | vazio | Promessa<void> Manipulador de eventos que é executado sempre antes de um usuário ser criado

Retorna:

Função de bloqueio

identidade.beforeUserSignedIn()

Lida com um evento que é acionado antes de um usuário entrar.

Assinatura:

export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

Parâmetros

Parâmetro Tipo Descrição
manipulador (evento: AuthBlockingEvent ) => BeforeSignInResponse | Promessa<BeforeSignInResponse> | vazio | Promessa<void> Manipulador de eventos que é executado sempre antes de um usuário fazer login

Retorna:

Função de bloqueio

identidade.beforeUserSignedIn()

Lida com um evento que é acionado antes de um usuário entrar.

Assinatura:

export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

Parâmetros

Parâmetro Tipo Descrição
opta Opções de bloqueio Objeto contendo opções de função
manipulador (evento: AuthBlockingEvent ) => BeforeSignInResponse | Promessa<BeforeSignInResponse> | vazio | Promessa<void> Manipulador de eventos que é executado sempre antes de um usuário fazer login

Retorna:

Função de bloqueio

identidade.getOpts()

Assinatura:

export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;

Parâmetros

Parâmetro Tipo Descrição
opções de bloqueio Opções de bloqueio

Retorna:

Opções internas