installations package

The Firebase Installations Web SDK. This SDK does not work in a Node.js environment.

Functions

Interfaces

Type Aliases

function(app, ...)

getInstallations(app)

Returns an instance of Installations associated with the given FirebaseApp instance.

Signature:

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

Parameters

Returns:

Installations

function(installations, ...)

deleteInstallations(installations)

Deletes the Firebase Installation and all associated data.

Signature:

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

Parameters

Returns:

Promise<void>

getId(installations)

Creates a Firebase Installation if there isn't one for the app and returns the Installation ID.

Signature:

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

Parameters

Returns:

Promise<string>

getToken(installations, forceRefresh)

Returns a Firebase Installations auth token, identifying the current Firebase Installation.

Signature:

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

Parameters

Returns:

Promise<string>

onIdChange(installations, callback)

Sets a new callback that will get called when Installation ID changes. Returns an unsubscribe function that will remove the callback when called.

Signature:

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

Parameters

Returns:

IdChangeUnsubscribeFn

A function that can be called to unsubscribe.

IdChangeCallbackFn

An user defined callback function that gets called when Installations ID changes.

Signature:

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

IdChangeUnsubscribeFn

Unsubscribe a callback function previously added via IdChangeCallbackFn.

Signature:

export type IdChangeUnsubscribeFn = () => void;