installations package

L'SDK Web delle installazioni Firebase. Questo SDK non funziona in un ambiente Node.js.

Funzioni

Funzione Descrizione
funzione(app, ...)
getInstallazioni(app) Restituisce un'istanza di installazioni associata all'istanza FirebaseApp specificata.
funzione(installazioni, ...)
deleteInstallations(installazioni) Elimina l'installazione di Firebase e tutti i dati associati.
getId(installazioni) Crea un'installazione Firebase se non ne esiste una per l'app e restituisce l'ID di installazione.
getToken(installazioni, forceRefresh) Restituisce un token di autenticazione delle installazioni Firebase, identificando l'installazione Firebase corrente.
onIdChange(installazioni, callback) Imposta una nuova richiamata che verrà chiamata quando cambia l'ID di installazione. Restituisce una funzione di annullamento dell'iscrizione che rimuoverà la richiamata quando chiamata.

Interfacce

Interfaccia Descrizione
Installazioni Interfaccia pubblica dell'SDK di Firebase Installations.

Digitare Alias

Digita Alias Descrizione
IdChangeCallbackFn Una funzione di callback definita dall'utente che viene chiamata quando cambia l'ID di installazione.
IdChangeAnnullaiscrizioneFn Annulla la sottoscrizione di una funzione di richiamata aggiunta in precedenza tramite IdChangeCallbackFn .

funzione(app, ...)

getInstallazioni(app)

Restituisce un'istanza di installazioni associata all'istanza FirebaseApp specificata.

Firma:

export declare function getInstallations(app?: FirebaseApp): Installations;

Parametri

Parametro Tipo Descrizione
app FirebaseApp L'istanza FirebaseApp .

Ritorna:

Installazioni

funzione(installazioni, ...)

deleteInstallations(installazioni)

Elimina l'installazione di Firebase e tutti i dati associati.

Firma:

export declare function deleteInstallations(installations: Installations): Promise<void>;

Parametri

Parametro Tipo Descrizione
installazioni Installazioni L'istanza Installations .

Ritorna:

Promesso<vuoto>

getId(installazioni)

Crea un'installazione Firebase se non ne esiste una per l'app e restituisce l'ID di installazione.

Firma:

export declare function getId(installations: Installations): Promise<string>;

Parametri

Parametro Tipo Descrizione
installazioni Installazioni L'istanza Installations .

Ritorna:

Promesso<string>

getToken(installazioni, forceRefresh)

Restituisce un token di autenticazione delle installazioni Firebase, identificando l'installazione Firebase corrente.

Firma:

export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

Parametri

Parametro Tipo Descrizione
installazioni Installazioni L'istanza Installations .
forceRefresh booleano Forza l'aggiornamento indipendentemente dalla scadenza del token.

Ritorna:

Promesso<string>

onIdChange(installazioni, callback)

Imposta una nuova richiamata che verrà chiamata quando cambia l'ID di installazione. Restituisce una funzione di annullamento dell'iscrizione che rimuoverà la richiamata quando chiamata.

Firma:

export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;

Parametri

Parametro Tipo Descrizione
installazioni Installazioni L'istanza Installations .
richiamare IdChangeCallbackFn La funzione di callback che viene richiamata quando il FID cambia.

Ritorna:

IdChangeAnnullaiscrizioneFn

Una funzione che può essere chiamata per annullare l'iscrizione.

IdChangeCallbackFn

Una funzione di callback definita dall'utente che viene chiamata quando cambia l'ID di installazione.

Firma:

export declare type IdChangeCallbackFn = (installationId: string) => void;

IdChangeAnnullaiscrizioneFn

Annulla la sottoscrizione di una funzione di richiamata aggiunta in precedenza tramite IdChangeCallbackFn .

Firma:

export declare type IdChangeUnsubscribeFn = () => void;