Firebase.Installations.FirebaseInstallations

Installations provides a unique identifier for each app instance and a mechanism to authenticate and authorize actions (for example, sending an FCM message).

Summary

Provides a unique identifier for a Firebase installation. Provides an auth token for a Firebase installation. Provides a API to perform data deletion for a Firebase installation.

Inheritance

Inherits from: SystemIDisposable

Properties
`App`	`FirebaseApp` App object associated with this Installations.
`DefaultInstance`	`static FirebaseInstallations` Installations associated with the default Firebase App.

Public functions
`DeleteAsync()`	`System.Threading.Tasks.Task` Delete the ID associated with the app, revoke all tokens, and allocate a new ID.
`Dispose()`	`void`
`Dispose(bool disposing)`	`virtual void`
`GetIdAsync()`	`System.Threading.Tasks.Task< string >` Returns a stable identifier that uniquely identifies the app instance.
`GetTokenAsync(bool forceRefresh)`	`System.Threading.Tasks.Task< string >` Returns a token that authorizes an Entity to perform an action on behalf of the application identified by Installations.

Public static functions
`GetInstance(FirebaseApp app)`	`FirebaseInstallations` Returns the `Installations` object for an `App` creating the `Installations` if required.

Properties

App

FirebaseApp App

App object associated with this Installations.

DefaultInstance

static FirebaseInstallations DefaultInstance

Installations associated with the default Firebase App.

Details
Returns	An Installations object associated with the default Firebase App.

Public functions

DeleteAsync

System.Threading.Tasks.Task DeleteAsync()

Delete the ID associated with the app, revoke all tokens, and allocate a new ID.

Dispose

void Dispose()

Dispose

virtual void Dispose(
  bool disposing
)

GetIdAsync

System.Threading.Tasks.Task< string > GetIdAsync()

Returns a stable identifier that uniquely identifies the app instance.

Details
Returns	Unique identifier for the app instance.

GetTokenAsync

System.Threading.Tasks.Task< string > GetTokenAsync(
  bool forceRefresh
)

Returns a token that authorizes an Entity to perform an action on behalf of the application identified by Installations.

This is similar to an OAuth2 token except it applies to the application instance instead of a user.

For example, to get a token that can be used to send messages to an application via Firebase Cloud Messaging, set entity to the sender ID, and set scope to "FCM".

Details
Returns	A token that can identify and authorize the instance of the application on the device.

Public static functions

GetInstance

FirebaseInstallations GetInstance(
  FirebaseApp app
)

Returns the Installations object for an App creating the Installations if required.

Details

Parameters

app

The App to create an Installations object from. On iOS and tvOS this must be the default FirebaseApp.

Returns

Installations object if successful, null otherwise.