IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

com.google.firebase.ml.modeldownloader

Classes

`CustomModel`	Stores information about custom models that are being downloaded or are already downloaded on a device.
`CustomModelDownloadConditions`	Conditions to allow download of custom models.
`CustomModelDownloadConditions.Builder`	Builder of `CustomModelDownloadConditions`.
`FirebaseModelDownloader`

Exceptions

FirebaseMlException

Represents an Exception resulting from an operation on a FirebaseModelDownloader.

Annotations

FirebaseMlException.Code

The set of Firebase ML status codes.

Enums

DownloadType

Top-level functions summary

CustomModelDownloadConditions

customModelDownloadConditions(init: CustomModelDownloadConditions.Builder.() -> Unit)

Returns a CustomModelDownloadConditions initialized using the init function.

Extension functions summary

`operator File?`	`CustomModel.component1()`
`operator Long`	`CustomModel.component2()`
`operator Long`	`CustomModel.component3()`
`operator String`	`CustomModel.component4()`
`operator String`	`CustomModel.component5()`
`FirebaseModelDownloader`	`Firebase.modelDownloader(app: FirebaseApp)` Returns the `FirebaseModelDownloader` instance of a given `FirebaseApp`.

Extension properties summary

FirebaseModelDownloader

Firebase.modelDownloader

Returns the FirebaseModelDownloader instance of the default FirebaseApp.

Top-level functions

customModelDownloadConditions

fun customModelDownloadConditions(init: CustomModelDownloadConditions.Builder.() -> Unit): CustomModelDownloadConditions

Returns a CustomModelDownloadConditions initialized using the init function.

Extension functions

component1

operator fun CustomModel.component1(): File?

component2

operator fun CustomModel.component2(): Long

component3

operator fun CustomModel.component3(): Long

component4

operator fun CustomModel.component4(): String

component5

operator fun CustomModel.component5(): String

modelDownloader

fun Firebase.modelDownloader(app: FirebaseApp): FirebaseModelDownloader

Returns the FirebaseModelDownloader instance of a given FirebaseApp.

Extension properties

modelDownloader

val Firebase.modelDownloader: FirebaseModelDownloader

Returns the FirebaseModelDownloader instance of the default FirebaseApp.