firebase-admin.extensions package

Servizio estensioni Firebase.

Funzioni

Funzione Descrizione
getExtensions(app) Ottiene il servizio Estensioni per l'app predefinita o per una determinata app. getExtensions() può essere chiamato senza argomenti per accedere al servizio Extensions dell'app predefinita o come getExtensions(app) per accedere al servizio Extensions associato a un'app specifica.

Classi

Classe Descrizione
Estensioni L'interfaccia del servizio Firebase Extensions .
Durata Runtime fornisce metodi per modificare i dati di runtime di un'istanza di estensione.

Digitare Alias

Digita Alias Descrizione
Stato di elaborazione impostabile SettableProcessingState rappresenta tutti gli stati di elaborazione che possono essere impostati sui dati di runtime di un'istanza di estensione.

getExtension()

Ottiene il servizio Estensioni per l'app predefinita o per una determinata app.

getExtensions() può essere chiamato senza argomenti per accedere al servizio Extensions dell'app predefinita o come getExtensions(app) per accedere al servizio Extensions associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App facoltativa per la quale restituire il servizio Extensions . Se non fornito, viene restituito il servizio Extensions predefinito.

Ritorna:

Estensioni

Il servizio Extensions predefinito se non viene fornita alcuna app o il servizio Extensions associato all'app fornita.

Esempio 1

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

Esempio 2

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

Stato di elaborazione impostabile

SettableProcessingState rappresenta tutti gli stati di elaborazione che possono essere impostati sui dati di runtime di un'istanza di estensione.

È possibile impostare i seguenti stati:

  • NONE : non è stato svolto alcun lavoro rilevante sugli eventi del ciclo di vita. Impostalo per cancellare i vecchi stati.

  • PROCESSING_COMPLETE : il lavoro sugli eventi del ciclo di vita è stato completato senza errori.

  • PROCESSING_WARNING : il lavoro sugli eventi del ciclo di vita è riuscito parzialmente o si è verificato qualcosa di cui l'utente dovrebbe essere avvisato.

  • PROCESSING_FAILED : il lavoro sugli eventi del ciclo di vita non è riuscito completamente, ma l'istanza continuerà a funzionare correttamente in futuro.

Se l'istanza dell'estensione è in uno stato interrotto a causa di errori, chiama invece Runtime.setFatalError() .

Lo stato di "elaborazione" viene impostato automaticamente all'avvio di un gestore di eventi del ciclo di vita; non puoi impostarlo esplicitamente. Per segnalare lo stato in corso della funzione di un'estensione, utilizza console.log o l'SDK del logger Cloud Functions.

Firma:

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