DeepLinkRequest.Companion

Summary

Nested types

The key of the mimeType stored inside the map returned by mimeTypeExtra.

Public functions
Map<String, Any>
mimeTypeExtra(mimeType: String)

Returns a Map that stores the provided mimeTypeExtra with the key MimeTypeExtrasKey.
Cmn

Extension functions
Map<String, Any>

Returns a Map that stores the provided actionExtra with the key ActionExtrasKey.
android
operator DeepLinkRequest
DeepLinkRequest.Companion.invoke(
    intent: Intent,
    extras: Map<String, Any>
)

Creates a DeepLinkRequest with an Intent.
android

Extension properties
RequestExtrasKey<String>

The key of the Action stored inside the map returned by actionExtra.
android

Public functions

mimeTypeExtra

Cmn
Added in 1.2.0-alpha05
fun mimeTypeExtra(mimeType: String): Map<String, Any>

Returns a Map that stores the provided mimeTypeExtra with the key MimeTypeExtrasKey.

The value can be retrieved via map.get(MimeTypeExtrasKey).

Extension functions

DeepLinkRequest.Companion.actionExtra

android 
fun DeepLinkRequest.Companion.actionExtra(action: String): Map<String, Any>

Returns a Map that stores the provided actionExtra with the key ActionExtrasKey.

The value can be retrieved via map.get(ActionExtrasKey).

DeepLinkRequest.Companion.invoke

android 
operator fun DeepLinkRequest.Companion.invoke(
    intent: Intent,
    extras: Map<String, Any> = emptyMap()
): DeepLinkRequest

Creates a DeepLinkRequest with an Intent.

The returned DeepLinkRequest will be populated with the following data:

  1. DeepLinkRequest.uri will be Intent.getData if not null

  2. DeepLinkRequest.extras will contain any non-null information from Intent.getType, Intent.getAction, and Intent.getExtras.

Parameters
intent: Intent

The Intent with the metadata to construct a DeepLinkRequest
extras: Map<String, Any> = emptyMap()

The map holding pairs of String to Any to provide extra information to the DeepLinkRequest, such a mimeType. If stored under the same key, all information inside the extras map will take precedence over the information in the intent.
Returns
DeepLinkRequest

a DeepLinkRequest instance

Extension properties

DeepLinkRequest.Companion.ActionExtrasKey

android 
val DeepLinkRequest.Companion.ActionExtrasKey: RequestExtrasKey<String>

The key of the Action stored inside the map returned by actionExtra.