The Firebase Installations service interface.

Do not call this constructor directly. Instead, use firebase.installations().

Index

Properties

Methods

Properties

app

app: App

The app associated with the Installations service instance.

example
var app = analytics.app;

Methods

delete

  • delete ( ) : Promise < void >

  • Deletes the Firebase Installation and all associated data.

    Returns Promise<void>

getId

  • getId ( ) : Promise < string >

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

    Returns Promise<string>

    Firebase Installation ID

getToken

  • getToken ( forceRefresh ? :  boolean ) : Promise < string >

  • Returns an Authentication Token for the current Firebase Installation.

    Parameters

    • Optional forceRefresh: boolean

    Returns Promise<string>

    Firebase Installation Authentication Token

onIdChange

  • onIdChange ( callback :  ( installationId :  string ) => void ) : ( ) => void

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

    Parameters

    • callback: (installationId: string) => void
        • (installationId: string): void

        • Parameters

          • installationId: string

          Returns void

    Returns () => void

      • (): void

      • Returns void