Les fonctions
| Fonction | Description |
|---|---|
| beforeOperation (eventType, optsOrHandler, gestionnaire) | |
| avantUserCreated(gestionnaire) | Gère un événement déclenché avant la création d’un utilisateur. |
| beforeUserCreated (opts, gestionnaire) | Gère un événement déclenché avant la création d’un utilisateur. |
| avantUserSignedIn (gestionnaire) | Gère un événement déclenché avant qu’un utilisateur ne soit connecté. |
| beforeUserSignedIn (opts, gestionnaire) | Gère un événement déclenché avant qu’un utilisateur ne soit connecté. |
| getOpts (options de blocage) |
Des classes
| Classe | Description |
|---|---|
| HttpsErreur | Erreur explicite qui peut être générée par un gestionnaire pour envoyer une erreur au client qui a appelé la fonction. |
Interfaces
| Interface | Description |
|---|---|
| Événement AuthBlocking | Définit l'événement d'authentification pour les événements de blocage de 2e génération |
| AuthUserRecord | Le UserRecord transmis aux fonctions de blocage d’authentification depuis la plateforme d’identité. |
| Options de blocage | Toutes les options de fonction plus idToken, accessToken etfreshToken. |
identité.beforeOperation()
Signature:
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;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| type d'événement | AuthBlockingEventType | |
| optsOrHandler | Options de blocage | ((événement : AuthBlockingEvent ) => AvantCréerRéponse | AvantConnexionRéponse | vide | Promesse<BeforeCreateResponse> | Promesse<BeforeSignInResponse> | Promesse<vide>) | |
| gestionnaire | (événement : AuthBlockingEvent ) => AvantCréerRéponse | AvantConnexionRéponse | vide | Promesse<BeforeCreateResponse> | Promesse<BeforeSignInResponse> | Promesse<vide> |
Retour:
Fonction de blocage
identité.beforeUserCreated()
Gère un événement déclenché avant la création d’un utilisateur.
Signature:
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| gestionnaire | (événement : AuthBlockingEvent ) => AvantCréerRéponse | Promesse<BeforeCreateResponse> | vide | Promesse<vide> | Gestionnaire d'événements qui est exécuté à chaque fois avant la création d'un utilisateur |
Retour:
Fonction de blocage
identité.beforeUserCreated()
Gère un événement déclenché avant la création d’un utilisateur.
Signature:
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| opte | Options de blocage | Objet contenant des options de fonction |
| gestionnaire | (événement : AuthBlockingEvent ) => AvantCréerRéponse | Promesse<BeforeCreateResponse> | vide | Promesse<vide> | Gestionnaire d'événements qui est exécuté à chaque fois avant la création d'un utilisateur |
Retour:
Fonction de blocage
identité.beforeUserSignedIn()
Gère un événement déclenché avant qu’un utilisateur ne soit connecté.
Signature:
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| gestionnaire | (événement : AuthBlockingEvent ) => AvantSignInResponse | Promesse<BeforeSignInResponse> | vide | Promesse<vide> | Gestionnaire d'événements qui est exécuté à chaque fois avant qu'un utilisateur ne soit connecté |
Retour:
Fonction de blocage
identité.beforeUserSignedIn()
Gère un événement déclenché avant qu’un utilisateur ne soit connecté.
Signature:
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| opte | Options de blocage | Objet contenant des options de fonction |
| gestionnaire | (événement : AuthBlockingEvent ) => AvantSignInResponse | Promesse<BeforeSignInResponse> | vide | Promesse<vide> | Gestionnaire d'événements qui est exécuté à chaque fois avant qu'un utilisateur ne soit connecté |
Retour:
Fonction de blocage
identité.getOpts()
Signature:
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| options de blocage | Options de blocage |
Retour:
Options internes