Runtime class

Runtime fournit des méthodes pour modifier les données d'exécution d'une instance d'extension.

Signature:

export declare class Runtime 

Méthodes

Méthode Modificateurs Description
setFatalError (message d'erreur) Signale une erreur fatale lors de l’exécution d’un gestionnaire d’événements de cycle de vie.
setProcessingState (état, message détaillé) Définit l'état de traitement d'une instance d'extension.

Runtime.setFatalError()

Signale une erreur fatale lors de l’exécution d’un gestionnaire d’événements de cycle de vie.

Appelez cette méthode lorsqu'un gestionnaire d'événements de cycle de vie échoue d'une manière qui rend l'instance inutilisable. Si l'événement du cycle de vie a échoué mais que l'instance fonctionnera toujours comme prévu, appelez plutôt setProcessingState avec l'état « PROCESSING_WARNING » ou « PROCESSING_FAILED ».

Signature:

setFatalError(errorMessage: string): Promise<void>;

Paramètres

Paramètre Taper Description
Message d'erreur chaîne Un message expliquant ce qui n'a pas fonctionné et comment y remédier.

Retour:

Promesse<vide>

Runtime.setProcessingState()

Définit l'état de traitement d'une instance d'extension.

Utilisez cette méthode pour signaler les résultats d’un gestionnaire d’événements de cycle de vie.

Si l'événement du cycle de vie a échoué et que l'instance d'extension ne fonctionne plus correctement, utilisez plutôt Runtime.setFatalError() .

Pour signaler l'état des appels de fonction autres que les gestionnaires d'événements de cycle de vie, utilisez console.log ou le SDK de l'enregistreur Cloud Functions.

Signature:

setProcessingState(state: SettableProcessingState, detailMessage: string): Promise<void>;

Paramètres

Paramètre Taper Description
État SettableProcessingState L’état dans lequel définir l’instance.
message détaillé chaîne Un message expliquant les résultats de la fonction de cycle de vie.

Retour:

Promesse<vide>