identity namespace

Funções

Função	Descrição
beforeOperation(eventType, optsOrHandler, handle)
beforeUserCreated(handler)	Processa um evento acionado antes da criação de um usuário.
beforeUserCreated(opts, handle)	Processa um evento acionado antes da criação de um usuário.
beforeUserSignedIn(handler)	Processa um evento acionado antes do login do usuário.
beforeUserSignedIn(opts, handle)	Processa um evento acionado antes do login do usuário.
getOpts(BlockingOptions)

Classes

Turma	Descrição
HttpsError (em inglês)	Um erro explícito que pode ser gerado a partir de um manipulador para enviar um erro ao cliente que chamou a função.

Interfaces

Interface	Descrição
AuthBlockingEvent	Define o evento de autenticação para eventos de bloqueio da 2a geração
AuthUserRecord (em inglês)	O UserRecord transmitido para autenticação de funções de bloqueio da plataforma de identidade.
BlockingOptions	Todas as opções de função mais idToken, accessToken e refreshToken.

Identity.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
eventType	AuthBlockingEventType
optsOrHandler	BlockingOptions | ((evento: AuthBlockingEvent) => beforeCreateResponse | beforeSignInResponse | void | Commit<BeforeCreateResponse> | Commit<BeforeSignInResponse> | Promessa<void>)
handler	(evento: AuthBlockingEvent) => beforeCreateResponse | AntesSignInResponse | anular | Promessa<Antes deCriarResponse> | Promessa<BeforeSignInResponse> | Promessa<void>

Retorna:

Função de bloqueio

Identity.beforeUserCreated()

Processa um evento acionado antes da criação de um usuário.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
handler	(evento: AuthBlockingEvent) => beforeCreateResponse | Promessa<Antes deCriarResponse> | anular | Promessa<void>	Manipulador de eventos que é executado sempre antes da criação de um usuário

Retorna:

Função de bloqueio

Identity.beforeUserCreated()

Processa um evento acionado antes da criação de um usuário.

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	BlockingOptions	Objeto contendo opções de função
handler	(evento: AuthBlockingEvent) => beforeCreateResponse | Promessa<Antes deCriarResponse> | anular | Promessa<void>	Manipulador de eventos que é executado sempre antes da criação de um usuário

Retorna:

Função de bloqueio

Identity.beforeUserSignedIn()

Processa um evento acionado antes do login do usuário.

Assinatura:

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

Parâmetros

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

Retorna:

Função de bloqueio

Identity.beforeUserSignedIn()

Processa um evento acionado antes do login do usuário.

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	BlockingOptions	Objeto contendo opções de função
handler	(evento: AuthBlockingEvent) => AntesSignInResponse | Promessa<BeforeSignInResponse> | anular | Promessa<void>	Manipulador de eventos que é executado sempre antes do login de um usuário

Retorna:

Função de bloqueio

Identity.getOpts()

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
blockOptions	BlockingOptions

Retorna:

InternalOptions