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.dynamiclinks

Interfaces

ShortDynamicLink

This interface is deprecated.

Firebase Dynamic Links is deprecated and should not be used in new projects.

ShortDynamicLink.Warning

This interface is deprecated.

Firebase Dynamic Links is deprecated and should not be used in new projects.

Classes

`DynamicLink`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.AndroidParameters`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.AndroidParameters.Builder`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.Builder`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.GoogleAnalyticsParameters`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.GoogleAnalyticsParameters.Builder`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.IosParameters.Builder`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.ItunesConnectAnalyticsParameters`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.ItunesConnectAnalyticsParameters.Builder`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.NavigationInfoParameters`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.NavigationInfoParameters.Builder`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.SocialMetaTagParameters`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`DynamicLink.SocialMetaTagParameters.Builder`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`FirebaseDynamicLinks`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.
`PendingDynamicLinkData`	This class is deprecated. Firebase Dynamic Links is deprecated and should not be used in new projects.

Annotations

ShortDynamicLink.Suffix

Path generation option for short Dynamic Link length

Extension functions summary

`Unit`	`DynamicLink.Builder.androidParameters(init: DynamicLink.AndroidParameters.Builder.() -> Unit)` Creates a `DynamicLink.AndroidParameters` object initialized using the `init` function and sets it to the `DynamicLink.Builder`
`Unit`	`DynamicLink.Builder.androidParameters( packageName: String, init: DynamicLink.AndroidParameters.Builder.() -> Unit )` Creates a `DynamicLink.AndroidParameters` object initialized with the specified `packageName` and using the `init` function and sets it to the `DynamicLink.Builder`
`operator Uri?`	`PendingDynamicLinkData.component1()` Destructuring declaration for `PendingDynamicLinkData` to provide link.
`operator Uri?`	`ShortDynamicLink.component1()` Destructuring declaration for `ShortDynamicLink` to provide shortLink.
`operator Int`	`PendingDynamicLinkData.component2()` Destructuring declaration for `PendingDynamicLinkData` to provide minimumAppVersion.
`operator Uri?`	`ShortDynamicLink.component2()` Destructuring declaration for `ShortDynamicLink` to provide previewLink.
`operator Long`	`PendingDynamicLinkData.component3()` Destructuring declaration for `PendingDynamicLinkData` to provide clickTimestamp.
`operator List<ShortDynamicLink.Warning>`	`ShortDynamicLink.component3()` Destructuring declaration for `ShortDynamicLink` to provide warnings.
`DynamicLink`	`FirebaseDynamicLinks.dynamicLink(init: DynamicLink.Builder.() -> Unit)` Creates a `DynamicLink` object initialized using the `init` function.
`FirebaseDynamicLinks`	`Firebase.dynamicLinks(app: FirebaseApp)` Returns the `FirebaseDynamicLinks` instance of a given `FirebaseApp`.
`Unit`	`DynamicLink.Builder.googleAnalyticsParameters(init: DynamicLink.GoogleAnalyticsParameters.Builder.() -> Unit)` Creates a `DynamicLink.GoogleAnalyticsParameters` object initialized using the `init` function and sets it to the `DynamicLink.Builder`
`Unit`	`DynamicLink.Builder.googleAnalyticsParameters( source: String, medium: String, campaign: String, init: DynamicLink.GoogleAnalyticsParameters.Builder.() -> Unit )` Creates a `DynamicLink.GoogleAnalyticsParameters` object initialized with the specified `source`, `medium`, `campaign` and using the `init` function and sets it to the `DynamicLink.Builder`.
`Unit`	`DynamicLink.Builder.iosParameters(bundleId: String, init: DynamicLink.IosParameters.Builder.() -> Unit)` Creates a `DynamicLink.IosParameters` object initialized with the specified `bundleId` and using the `init` function and sets it to the `DynamicLink.Builder`
`Unit`	`DynamicLink.Builder.itunesConnectAnalyticsParameters(init: DynamicLink.ItunesConnectAnalyticsParameters.Builder.() -> Unit)` Creates a `DynamicLink.ItunesConnectAnalyticsParameters` object initialized using the `init` function and sets it to the `DynamicLink.Builder`
`Unit`	`DynamicLink.Builder.navigationInfoParameters(init: DynamicLink.NavigationInfoParameters.Builder.() -> Unit)` Creates a `DynamicLink.NavigationInfoParameters` object initialized using the `init` function and sets it to the `DynamicLink.Builder`
`Task<ShortDynamicLink>`	`FirebaseDynamicLinks.shortLinkAsync(init: DynamicLink.Builder.() -> Unit)` Creates a `ShortDynamicLink` object initialized using the `init` function.
`Task<ShortDynamicLink>`	`FirebaseDynamicLinks.shortLinkAsync(suffix: Int, init: DynamicLink.Builder.() -> Unit)` Creates a `ShortDynamicLink` object initialized using the `init` function.
`Unit`	`DynamicLink.Builder.socialMetaTagParameters(init: DynamicLink.SocialMetaTagParameters.Builder.() -> Unit)` Creates a `DynamicLink.SocialMetaTagParameters` object initialized using the `init` function and sets it to the `DynamicLink.Builder`

Extension properties summary

FirebaseDynamicLinks

Firebase.dynamicLinks

Returns the FirebaseDynamicLinks instance of the default FirebaseApp.

Extension functions

androidParameters

fun DynamicLink.Builder.androidParameters(init: DynamicLink.AndroidParameters.Builder.() -> Unit): Unit

Creates a DynamicLink.AndroidParameters object initialized using the init function and sets it to the DynamicLink.Builder

androidParameters

fun DynamicLink.Builder.androidParameters(
    packageName: String,
    init: DynamicLink.AndroidParameters.Builder.() -> Unit
): Unit

Creates a DynamicLink.AndroidParameters object initialized with the specified packageName and using the init function and sets it to the DynamicLink.Builder

component1

operator fun PendingDynamicLinkData.component1(): Uri?

Destructuring declaration for PendingDynamicLinkData to provide link.

component1

operator fun ShortDynamicLink.component1(): Uri?

Destructuring declaration for ShortDynamicLink to provide shortLink.

component2

operator fun PendingDynamicLinkData.component2(): Int

Destructuring declaration for PendingDynamicLinkData to provide minimumAppVersion.

component2

operator fun ShortDynamicLink.component2(): Uri?

Destructuring declaration for ShortDynamicLink to provide previewLink.

component3

operator fun PendingDynamicLinkData.component3(): Long

Destructuring declaration for PendingDynamicLinkData to provide clickTimestamp.

component3

operator fun ShortDynamicLink.component3(): List<ShortDynamicLink.Warning>

Destructuring declaration for ShortDynamicLink to provide warnings.

dynamicLink

fun FirebaseDynamicLinks.dynamicLink(init: DynamicLink.Builder.() -> Unit): DynamicLink

Creates a DynamicLink object initialized using the init function.

dynamicLinks

fun Firebase.dynamicLinks(app: FirebaseApp): FirebaseDynamicLinks

Returns the FirebaseDynamicLinks instance of a given FirebaseApp.

googleAnalyticsParameters

fun DynamicLink.Builder.googleAnalyticsParameters(init: DynamicLink.GoogleAnalyticsParameters.Builder.() -> Unit): Unit

Creates a DynamicLink.GoogleAnalyticsParameters object initialized using the init function and sets it to the DynamicLink.Builder

googleAnalyticsParameters

fun DynamicLink.Builder.googleAnalyticsParameters(
    source: String,
    medium: String,
    campaign: String,
    init: DynamicLink.GoogleAnalyticsParameters.Builder.() -> Unit
): Unit

Creates a DynamicLink.GoogleAnalyticsParameters object initialized with the specified source, medium, campaign and using the init function and sets it to the DynamicLink.Builder.

iosParameters

fun DynamicLink.Builder.iosParameters(bundleId: String, init: DynamicLink.IosParameters.Builder.() -> Unit): Unit

Creates a DynamicLink.IosParameters object initialized with the specified bundleId and using the init function and sets it to the DynamicLink.Builder

itunesConnectAnalyticsParameters

fun DynamicLink.Builder.itunesConnectAnalyticsParameters(init: DynamicLink.ItunesConnectAnalyticsParameters.Builder.() -> Unit): Unit

Creates a DynamicLink.ItunesConnectAnalyticsParameters object initialized using the init function and sets it to the DynamicLink.Builder

navigationInfoParameters

fun DynamicLink.Builder.navigationInfoParameters(init: DynamicLink.NavigationInfoParameters.Builder.() -> Unit): Unit

Creates a DynamicLink.NavigationInfoParameters object initialized using the init function and sets it to the DynamicLink.Builder

shortLinkAsync

fun FirebaseDynamicLinks.shortLinkAsync(init: DynamicLink.Builder.() -> Unit): Task<ShortDynamicLink>

Creates a ShortDynamicLink object initialized using the init function.

shortLinkAsync

fun FirebaseDynamicLinks.shortLinkAsync(suffix: Int, init: DynamicLink.Builder.() -> Unit): Task<ShortDynamicLink>

Creates a ShortDynamicLink object initialized using the init function.

socialMetaTagParameters

fun DynamicLink.Builder.socialMetaTagParameters(init: DynamicLink.SocialMetaTagParameters.Builder.() -> Unit): Unit

Creates a DynamicLink.SocialMetaTagParameters object initialized using the init function and sets it to the DynamicLink.Builder

Extension properties

dynamicLinks

val Firebase.dynamicLinks: FirebaseDynamicLinks

Returns the FirebaseDynamicLinks instance of the default FirebaseApp.