NavDeepLinkRequest.Builder

Artifact: androidx.navigation:navigation-common

View Source

Added in 2.3.0

---

Kotlin |Java

Common/AllAndroid/JVM

• android

  class NavDeepLinkRequest.Builder

---

A builder for constructing NavDeepLinkRequest instances.

Summary

Public companion functions
NavDeepLinkRequest.Builder	fromAction(action: String) Creates a NavDeepLinkRequest.Builder with a set action.	android
NavDeepLinkRequest.Builder	fromMimeType(mimeType: String) Creates a NavDeepLinkRequest.Builder with a set mimeType.	android
NavDeepLinkRequest.Builder	fromUri(uri: Uri) Creates a NavDeepLinkRequest.Builder with a set uri.	android

Public functions
NavDeepLinkRequest	build() Build the NavDeepLinkRequest specified by this builder.	android
NavDeepLinkRequest.Builder	setAction(action: String) Set the action for the NavDeepLinkRequest.	android
NavDeepLinkRequest.Builder	setMimeType(mimeType: String) Set the mimeType for the NavDeepLinkRequest.	android
NavDeepLinkRequest.Builder	setUri(uri: Uri) Set the uri for the NavDeepLinkRequest.	android

Public companion functions

fromAction

android

Added in 2.4.0

fun fromAction(action: String): NavDeepLinkRequest.Builder

Creates a NavDeepLinkRequest.Builder with a set action.

Parameters
action: String	the intent action for the NavDeepLinkRequest

Returns
NavDeepLinkRequest.Builder	a Builder instance

Throws
kotlin.IllegalArgumentException	if the action is empty.

fromMimeType

android

Added in 2.4.0

fun fromMimeType(mimeType: String): NavDeepLinkRequest.Builder

Creates a NavDeepLinkRequest.Builder with a set mimeType.

Parameters
mimeType: String	the mimeType for the NavDeepLinkRequest

Returns
NavDeepLinkRequest.Builder	a Builder instance

fromUri

android

Added in 2.4.0

fun fromUri(uri: Uri): NavDeepLinkRequest.Builder

Creates a NavDeepLinkRequest.Builder with a set uri.

Parameters
uri: Uri	The uri to add to the NavDeepLinkRequest

Returns
NavDeepLinkRequest.Builder	a Builder instance

Public functions

build

android

Added in 2.3.0

fun build(): NavDeepLinkRequest

Build the NavDeepLinkRequest specified by this builder.

Returns
NavDeepLinkRequest	the newly constructed NavDeepLinkRequest

setAction

android

Added in 2.3.0

fun setAction(action: String): NavDeepLinkRequest.Builder

Set the action for the NavDeepLinkRequest.

Parameters
action: String	the intent action for the NavDeepLinkRequest

Returns
NavDeepLinkRequest.Builder	This builder.

Throws
kotlin.IllegalArgumentException	if the action is empty.

setMimeType

android

Added in 2.3.0

fun setMimeType(mimeType: String): NavDeepLinkRequest.Builder

Set the mimeType for the NavDeepLinkRequest.

Parameters
mimeType: String	the mimeType for the NavDeepLinkRequest

Returns
NavDeepLinkRequest.Builder	This builder.

Throws
kotlin.IllegalArgumentException	if the given mimeType does not match th3e required "type/subtype" format.

setUri

android

Added in 2.3.0

fun setUri(uri: Uri): NavDeepLinkRequest.Builder

Set the uri for the NavDeepLinkRequest.

Parameters
uri: Uri	The uri to add to the NavDeepLinkRequest

Returns
NavDeepLinkRequest.Builder	This builder.