MLKitCommon Framework Reference

  • Globally available constants provide notifications for observing model download tasks.

  • mlkitModelDownloadDidSucceed and mlkitModelDownloadDidFail are notification names for tracking model download success or failure, respectively.

  • User info dictionaries within these notifications contain details about the RemoteModel and potential errors using keys like remoteModel and error.

Constants

The following constants are available globally.

  • Notification name for observing model download tasks that succeed. The user info dictionary will contain {ModelDownloadUserInfoKey.remoteModel : RemoteModel}.

    Declaration

    Swift

    static let mlkitModelDownloadDidSucceed: NSNotification.Name

  • Notification name for observing model download tasks that fail. The user info dictionary will contain {ModelDownloadUserInfoKey.remoteModel : RemoteModel} and {ModelDownloadUserInfoKey.error : NSError}.

    Declaration

    Swift

    static let mlkitModelDownloadDidFail: NSNotification.Name

  • The key for retrieving the RemoteModel from the user info dictionary.

    Declaration

    Swift

    static let remoteModel: ModelDownloadUserInfoKey

  • The key for retrieving the NSError from the user info dictionary. The corresponding value is nil if the model download completed successfully.

    Declaration

    Swift

    static let error: ModelDownloadUserInfoKey