NavDeepLink.Builder

fun build(): NavDeepLink

Build the NavDeepLink specified by this builder.

fun setAction(action: String): NavDeepLink.Builder

Set the action for the NavDeepLink.

fun setMimeType(mimeType: String): NavDeepLink.Builder

Set the mimeType for the NavDeepLink.

fun setUriPattern(uriPattern: String): NavDeepLink.Builder

Set the uri pattern for the NavDeepLink.

inline fun <T : Any> setUriPattern(
    basePath: String,
    typeMap: Map<KType, NavType<*>> = emptyMap()
): NavDeepLink.Builder

Set the uri pattern for the NavDeepLink.

Arguments extracted from destination T will be automatically appended to the base path provided in basePath.

Arguments are appended based on property name and in the same order as their declaration order in T. They are appended as query parameters if the argument has either:

1. a default value

2. a NavType of CollectionNavType

Otherwise, the argument will be appended as path parameters. The final uriPattern is generated by concatenating uriPattern + path parameters + query parameters.

For example, the name property in this class does not meet either conditions and will be appended as a path param.

@Serializable
class MyClass(val name: String)

Given a uriPattern of "www.example.com", the generated final uriPattern will be www.example.com/{name}.

The name property in this class has a default value and will be appended as a query.

@Serializable
class MyClass(val name: String = "default")

Given a uriPattern of "www.example.com", the final generated uriPattern will be www.example.com?name={name}

The append order is based on their declaration order in T

@Serializable
class MyClass(val name: String = "default", val id: Int, val code: Int)

Given a uriPattern of "www.example.com", the final generated uriPattern will be www.example.com/{id}/{code}?name={name}. In this example, name is appended first as a query param, then id and code respectively as path params. The final pattern is then concatenated with uriPattern + path + query.

fun <T : Any> setUriPattern(
    route: KClass<T>,
    basePath: String,
    typeMap: Map<KType, NavType<*>> = emptyMap()
): NavDeepLink.Builder

Set the uri pattern for the NavDeepLink.

Arguments extracted from destination T will be automatically appended to the base path provided in basePath.

Arguments are appended based on property name and in the same order as their declaration order in T. They are appended as query parameters if the argument has either:

1. a default value

2. a NavType of CollectionNavType

Otherwise, the argument will be appended as path parameters. The final uriPattern is generated by concatenating uriPattern + path parameters + query parameters.

For example, the name property in this class does not meet either conditions and will be appended as a path param.

@Serializable
class MyClass(val name: String)

Given a uriPattern of "www.example.com", the generated final uriPattern will be www.example.com/{name}.

The name property in this class has a default value and will be appended as a query.

@Serializable
class MyClass(val name: String = "default")

Given a uriPattern of "www.example.com", the final generated uriPattern will be www.example.com?name={name}

The append order is based on their declaration order in T

@Serializable
class MyClass(val name: String = "default", val id: Int, val code: Int)

Given a uriPattern of "www.example.com", the final generated uriPattern will be www.example.com/{id}/{code}?name={name}. In this example, name is appended first as a query param, then id and code respectively as path params. The final pattern is then concatenated with uriPattern + path + query.