Funções
Função | Descrição |
---|---|
beforeOperation(eventType, optsOrHandler, manipulador) | |
antes de UserCreated (manipulador) | Manipula um evento que é acionado antes que um usuário seja criado. |
beforeUserCreated (opta, manipulador) | Manipula um evento que é acionado antes que um usuário seja criado. |
beforeUserSignedIn(manipulador) | Manipula um evento que é acionado antes de um usuário entrar. |
beforeUserSignedIn(opções, manipulador) | Manipula um evento que é acionado antes de um usuário entrar. |
getOpts(blockingOptions) |
Aulas
Aula | Descrição |
---|---|
HttpsErro | Um erro explícito que pode ser lançado 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 v2 |
AuthUserRecord | O UserRecord passou para o bloqueio de autenticação do Cloud Functions da plataforma de identidade. |
Opções de Bloqueio | Todas as opções de função mais idToken, accessToken e refreshToken. |
identidade. antes da operação ()
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 | Promise<BeforeCreateResponse> | Promessa<BeforeSignInResponse> | Prometo <void>) | |
manipulador | (evento: AuthBlockingEvent ) => BeforeCreateResponse | AntesSignInResponse | vazio | Promise<BeforeCreateResponse> | Promessa<BeforeSignInResponse> | Promessa<void> |
Retorna:
Função de Bloqueio
identity.beforeUserCreated()
Manipula um evento que é acionado antes que um usuário seja 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 | Promise<BeforeCreateResponse> | vazio | Promessa<void> | Manipulador de eventos que é executado toda vez antes de um usuário ser criado |
Retorna:
Função de Bloqueio
identity.beforeUserCreated()
Manipula um evento que é acionado antes que um usuário seja 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 | Promise<BeforeCreateResponse> | vazio | Promessa<void> | Manipulador de eventos que é executado toda vez antes de um usuário ser criado |
Retorna:
Função de Bloqueio
identity.beforeUserSignedIn()
Manipula 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 entrar |
Retorna:
Função de Bloqueio
identity.beforeUserSignedIn()
Manipula 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 entrar |
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