FIRModelManager


@interface FIRModelManager : NSObject

Manages models that are used by MLKit features.

  • Returns the ModelManager instance for the default Firebase app. The default Firebase app instance must be configured before calling this method; otherwise, raises FIRAppNotConfigured exception.

    Declaration

    Objective-C

    + (nonnull instancetype)modelManager;

    Return Value

    The ModelManager instance for the default Firebase app.

  • Returns the ModelManager instance for the given custom Firebase app. The custom Firebase app instance must be configured before calling this method; otherwise, raises FIRAppNotConfigured exception.

    Declaration

    Objective-C

    + (nonnull instancetype)modelManagerForApp:(nonnull FIRApp *)app;

    Parameters

    app

    The custom Firebase app instance.

    Return Value

    The ModelManager instance for the given custom Firebase app.

  • Unavailable. Use the modelManager() or modelManager(app:) class methods.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Checks whether the given model has been downloaded.

    Declaration

    Objective-C

    - (BOOL)isModelDownloaded:(nonnull FIRRemoteModel *)remoteModel;

    Parameters

    remoteModel

    The model to check the download status for.

    Return Value

    Whether the given model has been downloaded.

  • Downloads the given model from the server to a local directory on the device. Use isModelDownloaded(_:) to check the download status for the model. If this method is invoked and the model has already been downloaded, a request is made to check if a newer version of the model is available for download. If available, the new version of the model is downloaded.

    To be notified when a model download request completes, observe the .firebaseMLModelDownloadDidSucceedand .firebaseMLModelDownloadDidFail notifications defined in FIRModelDownloadNotifications.h.

    Declaration

    Objective-C

    - (nonnull NSProgress *)downloadModel:(nonnull FIRRemoteModel *)remoteModel
                               conditions:
                                   (nonnull FIRModelDownloadConditions *)conditions;

    Parameters

    remoteModel

    The model to download.

    conditions

    The conditions for downloading the model.

    Return Value

    Progress for downloading the model.

  • Deletes the downloaded model from the device.

    Declaration

    Objective-C

    - (void)deleteDownloadedModel:(nonnull FIRRemoteModel *)remoteModel
                       completion:(nonnull void (^)(NSError *_Nullable))completion;

    Parameters

    remoteModel

    The downloaded model to delete.

    completion

    Handler to call back on the main queue when the model deletion completed successfully or failed with the given error.