FirebaseInstallations Framework Reference

Installations

class Installations : NSObject

The class provides API for Firebase Installations. Each configured FirebaseApp has a corresponding single instance of Installations. An instance of the class provides access to the installation info for the FirebaseApp as well as the ability to delete it. A Firebase Installation is unique by FirebaseApp.name and FirebaseApp.options.googleAppID .

  • Undocumented

  • Returns a default instance of Installations. Returns An instance of Installations for FirebaseApp.defaultApp(). @throw Throws an exception if the default app is not configured yet or requiredFirebaseApp` options are missing.

    Declaration

    Swift

    class func installations() -> Installations

  • Returns an instance of Installations for an application.

    Declaration

    Swift

    class func installations(app application: FIRApp) -> Installations

    Parameters

    application

    A configured FirebaseApp instance. Returns An instance of Installations corresponding to the passed application. @throw Throws an exception if required FirebaseApp options are missing.

  • The method creates or retrieves an installation ID. The installation ID is a stable identifier that uniquely identifies the app instance. NOTE: If the application already has an existing FirebaseInstanceID then the InstanceID identifier will be used.

    Declaration

    Swift

    func installationID(completion: @escaping InstallationsIDHandler)

    Parameters

    completion

    A completion handler which is invoked when the operation completes. See InstallationsIDHandler for additional details.

  • Retrieves (locally if it exists or from the server) a valid installation auth token. An existing token may be invalidated or expired, so it is recommended to fetch the installation auth token before each server request. The method does the same as Installations.authTokenForcingRefresh(:, completion:) with forcing refresh NO.

    Declaration

    Swift

    func authToken(completion: @escaping InstallationsTokenHandler)

    Parameters

    completion

    A completion handler which is invoked when the operation completes. See InstallationsTokenHandler for additional details.

  • Retrieves (locally or from the server depending on forceRefresh value) a valid installation auth token. An existing token may be invalidated or expire, so it is recommended to fetch the installation auth token before each server request. This method should be used with forceRefresh == YES when e.g. a request with the previously fetched installation auth token failed with “Not Authorized” error.

    Declaration

    Swift

    func authTokenForcingRefresh(_ forceRefresh: Bool, completion: @escaping InstallationsTokenHandler)

    Parameters

    forceRefresh

    If YES then the locally cached installation auth token will be ignored and a new one will be requested from the server. If NO, then the locally cached installation auth token will be returned if exists and has not expired yet.
    completion

    A completion handler which is invoked when the operation completes. See InstallationsTokenHandler for additional details.

  • Deletes all the installation data including the unique identifier, auth tokens and all related data on the server side. A network connection is required for the method to succeed. If fails, the existing installation data remains untouched.

    Declaration

    Swift

    func delete(completion: @escaping (Error?) -> Void)

    Parameters

    completion

    A completion handler which is invoked when the operation completes. error == nil indicates success.