Represents a requested deep link.

Summary

Nested types

Public companion functions

DeepLinkRequest
fromAction(action: String, uri: DeepLinkUri?, mimeType: String?)

Creates a [DeepLinkRequest with an action.

Cmn
DeepLinkRequest
fromMimeType(mimeType: String, uri: DeepLinkUri?, action: String?)

Creates a DeepLinkRequest with a mimeType.

Cmn
DeepLinkRequest
fromUri(uri: DeepLinkUri, mimeType: String?, action: String?)

Creates a DeepLinkRequest with a DeepLinkUri.

Cmn
DeepLinkRequest
fromUriString(uri: String, mimeType: String?, action: String?)

Creates a DeepLinkRequest with a string uri.

Cmn

Public functions

open String
Cmn

Public properties

String?

The action for the deep link.

Cmn
String?

The mime type for the deep link.

Cmn
DeepLinkUri?

The URI for the deep link.

Cmn

Public companion functions

fromAction

fun fromAction(action: String, uri: DeepLinkUri? = null, mimeType: String? = null): DeepLinkRequest

Creates a [DeepLinkRequest with an action.

Parameters
action: String

The action for the deep link.

uri: DeepLinkUri? = null

The URI for the deep link.

mimeType: String? = null

The mime type for the deep link.

Returns
DeepLinkRequest

a DeepLinkRequest instance

Throws
IllegalArgumentException

if the action is empty.

fromMimeType

fun fromMimeType(mimeType: String, uri: DeepLinkUri? = null, action: String? = null): DeepLinkRequest

Creates a DeepLinkRequest with a mimeType.

Parameters
mimeType: String

The mime type for the deep link.

uri: DeepLinkUri? = null

The URI for the deep link.

action: String? = null

The action for the deep link.

Returns
DeepLinkRequest

a DeepLinkRequest instance

Throws
IllegalArgumentException

if the mimeType is empty.

fromUri

fun fromUri(uri: DeepLinkUri, mimeType: String? = null, action: String? = null): DeepLinkRequest

Creates a DeepLinkRequest with a DeepLinkUri.

Parameters
uri: DeepLinkUri

The URI for the deep link.

mimeType: String? = null

The mime type for the deep link.

action: String? = null

The action for the deep link.

Returns
DeepLinkRequest

a DeepLinkRequest instance

fromUriString

fun fromUriString(uri: String, mimeType: String? = null, action: String? = null): DeepLinkRequest

Creates a DeepLinkRequest with a string uri.

Parameters
uri: String

The URI for the deep link.

mimeType: String? = null

The mime type for the deep link.

action: String? = null

The action for the deep link.

Returns
DeepLinkRequest

a DeepLinkRequest instance

Public functions

toString

open fun toString(): String

Public properties

action

val actionString?

The action for the deep link.

mimeType

val mimeTypeString?

The mime type for the deep link.

uri

val uriDeepLinkUri?

The URI for the deep link.