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 ofInstallations associated with the givenFirebaseApp instance.

Signature:

exportdeclarefunctiongetInstallations(app?:FirebaseApp):Installations;

Parameters

Returns:

Installations

function(installations, ...)

deleteInstallations(installations)

Deletes the Firebase Installation and all associated data.

Signature:

exportdeclarefunctiondeleteInstallations(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:

exportdeclarefunctiongetId(installations:Installations):Promise<string>;

Parameters

Returns:

Promise<string>

getToken(installations, forceRefresh)

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

Signature:

exportdeclarefunctiongetToken(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:

exportdeclarefunctiononIdChange(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:

exporttypeIdChangeCallbackFn=(installationId:string)=>void;

IdChangeUnsubscribeFn

Unsubscribe a callback function previously added viaIdChangeCallbackFn.

Signature:

exporttypeIdChangeUnsubscribeFn=()=>void;