devsite/tools/jazzy/templates

FirebaseInstallations Framework Reference

FIRInstallations


@interface FIRInstallations : 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 .

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Returns a default instance of Installations.

    Declaration

    Objective-C

    + (nonnull FIRInstallations *)installations;

    Return Value

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

  • Returns an instance of Installations for an application.

    Declaration

    Objective-C

    + (nonnull FIRInstallations *)installationsWithApp:
    (nonnull FIRApp *)application;

    Parameters

    application

    A configured FirebaseApp instance.

    Return Value

    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

    Objective-C

    - (void)installationIDWithCompletion:
    (nonnull void (^)(NSString *_Nullable, NSError *_Nullable))completion;

    Parameters

    completion

    A completion handler which is invoked when the operation completes.

  • 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.authToken(forcingRefresh:completion:) with forcing refresh false.

    Declaration

    Objective-C

    - (void)authTokenWithCompletion:
    (nonnull void (^)(FIRInstallationsAuthTokenResult *_Nullable,
                      NSError *_Nullable))completion;

    Parameters

    completion

    A completion handler which is invoked when the operation completes.

  • 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 == true when e.g. a request with the previously fetched installation auth token failed with “Not Authorized” error.

    Declaration

    Objective-C

    - (void)authTokenForcingRefresh:(BOOL)forceRefresh
                     completion:(nonnull void (^)(
                                    FIRInstallationsAuthTokenResult *_Nullable,
                                    NSError *_Nullable))completion;

    Parameters

    forceRefresh

    If true then the locally cached installation auth token will be ignored and a new one will be requested from the server. If false, 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

    Objective-C

    - (void)deleteWithCompletion:(nonnull void (^)(NSError *_Nullable))completion;

    Parameters

    completion

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