firebase-admin.extensions package

Service d'extensions Firebase.

Les fonctions

Fonction Description
getExtensions (application) Obtient le service Extensions pour l’application par défaut ou une application donnée. getExtensions() peut être appelé sans argument pour accéder au service Extensions de l'application par défaut ou en tant que getExtensions(app) pour accéder au service Extensions associé à une application spécifique.

Des classes

Classe Description
Rallonges L'interface du service Extensions Firebase.
Durée Runtime fournit des méthodes pour modifier les données d'exécution d'une instance d'extension.

Tapez les alias

Tapez l'alias Description
SettableProcessingState SettableProcessingState représente tous les états de traitement qui peuvent être définis sur les données d'exécution d'une instance d'extension.

obtenirExtensions()

Obtient le service Extensions pour l’application par défaut ou une application donnée.

getExtensions() peut être appelé sans argument pour accéder au service Extensions de l'application par défaut ou en tant que getExtensions(app) pour accéder au service Extensions associé à une application spécifique.

Signature:

export declare function getExtensions(app?: App): Extensions;

Paramètres

Paramètre Taper Description
application Application Application facultative pour laquelle renvoyer le service Extensions . S’il n’est pas fourni, le service Extensions par défaut est renvoyé.

Retour:

Rallonges

Le service Extensions par défaut si aucune application n'est fournie, ou le service Extensions associé à l'application fournie.

Exemple 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

Exemple 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

SettableProcessingState

SettableProcessingState représente tous les états de traitement qui peuvent être définis sur les données d'exécution d'une instance d'extension.

Vous pouvez définir les états suivants :

  • NONE : Aucun travail pertinent sur les événements du cycle de vie n’a été effectué. Définissez ceci pour effacer les anciens statuts.

  • PROCESSING_COMPLETE : Travail sur les événements du cycle de vie terminé sans erreur.

  • PROCESSING_WARNING : le travail sur les événements du cycle de vie a réussi partiellement, ou quelque chose s'est produit dont l'utilisateur doit être averti.

  • PROCESSING_FAILED : Le travail sur les événements du cycle de vie a complètement échoué, mais l'instance fonctionnera toujours correctement à l'avenir.

Si l'instance d'extension est dans un état cassé en raison d'erreurs, appelez plutôt Runtime.setFatalError() .

L'état « traitement » est défini automatiquement lorsqu'un gestionnaire d'événements de cycle de vie démarre ; vous ne pouvez pas le définir explicitement. Pour signaler l'état en cours de la fonction d'une extension, utilisez console.log ou le SDK de l'enregistreur Cloud Functions.

Signature:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';