NavDeepLinkRequest.Builder

Artifact: androidx.navigation:navigation-common

View Source

Added in 2.3.0

---

Kotlin |Java

public final class NavDeepLinkRequest.Builder

---

A builder for constructing NavDeepLinkRequest instances.

Summary

Public methods
final @NonNull NavDeepLinkRequest	build() Build the NavDeepLinkRequest specified by this builder.
static final @NonNull NavDeepLinkRequest.Builder	fromAction(@NonNull String action) Creates a NavDeepLinkRequest.Builder with a set action.
static final @NonNull NavDeepLinkRequest.Builder	fromMimeType(@NonNull String mimeType) Creates a NavDeepLinkRequest.Builder with a set mimeType.
static final @NonNull NavDeepLinkRequest.Builder	fromUri(@NonNull Uri uri) Creates a NavDeepLinkRequest.Builder with a set uri.
final @NonNull NavDeepLinkRequest.Builder	setAction(@NonNull String action) Set the action for the NavDeepLinkRequest.
final @NonNull NavDeepLinkRequest.Builder	setMimeType(@NonNull String mimeType) Set the mimeType for the NavDeepLinkRequest.
final @NonNull NavDeepLinkRequest.Builder	setUri(@NonNull Uri uri) Set the uri for the NavDeepLinkRequest.

Public methods

build

Added in 2.3.0

public final @NonNull NavDeepLinkRequest build()

Build the NavDeepLinkRequest specified by this builder.

Returns
@NonNull NavDeepLinkRequest	the newly constructed NavDeepLinkRequest

fromAction

Added in 2.4.0

public static final @NonNull NavDeepLinkRequest.Builder fromAction(@NonNull String action)

Creates a NavDeepLinkRequest.Builder with a set action.

Parameters
@NonNull String action	the intent action for the NavDeepLinkRequest

Returns
@NonNull NavDeepLinkRequest.Builder	a Builder instance

Throws
kotlin.IllegalArgumentException	if the action is empty.

fromMimeType

Added in 2.4.0

public static final @NonNull NavDeepLinkRequest.Builder fromMimeType(@NonNull String mimeType)

Creates a NavDeepLinkRequest.Builder with a set mimeType.

Parameters
@NonNull String mimeType	the mimeType for the NavDeepLinkRequest

Returns
@NonNull NavDeepLinkRequest.Builder	a Builder instance

fromUri

Added in 2.4.0

public static final @NonNull NavDeepLinkRequest.Builder fromUri(@NonNull Uri uri)

Creates a NavDeepLinkRequest.Builder with a set uri.

Parameters
@NonNull Uri uri	The uri to add to the NavDeepLinkRequest

Returns
@NonNull NavDeepLinkRequest.Builder	a Builder instance

setAction

Added in 2.3.0

public final @NonNull NavDeepLinkRequest.Builder setAction(@NonNull String action)

Set the action for the NavDeepLinkRequest.

Parameters
@NonNull String action	the intent action for the NavDeepLinkRequest

Returns
@NonNull NavDeepLinkRequest.Builder	This builder.

Throws
kotlin.IllegalArgumentException	if the action is empty.

setMimeType

Added in 2.3.0

public final @NonNull NavDeepLinkRequest.Builder setMimeType(@NonNull String mimeType)

Set the mimeType for the NavDeepLinkRequest.

Parameters
@NonNull String mimeType	the mimeType for the NavDeepLinkRequest

Returns
@NonNull NavDeepLinkRequest.Builder	This builder.

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

setUri

Added in 2.3.0

public final @NonNull NavDeepLinkRequest.Builder setUri(@NonNull Uri uri)

Set the uri for the NavDeepLinkRequest.

Parameters
@NonNull Uri uri	The uri to add to the NavDeepLinkRequest

Returns
@NonNull NavDeepLinkRequest.Builder	This builder.