SettingsSearchEntry

data class SettingsSearchEntry(val title: StringResource, val description: StringResource?, val route: Route, val screenTitle: StringResource, val keywords: StringResource? = null, val fieldKey: String? = null, val isAppLocal: Boolean = false)(source)

One thing the user can search for: a settings screen, or a single control on one.

Parameters

title

the row's own name. For a proto-backed control this is the schema's label.

description

the schema's one-sentence explanation, where it has one. Matched as well as shown.

route

where tapping the result goes.

screenTitle

the destination's name, shown beside the result so "Enabled" says which Enabled it is.

keywords

the schema's |-separated extra search terms, where it has them. Matched, never shown.

fieldKey

the schema string key of the control, which a config screen's list item can carry as its key. Null for a screen or an app-level setting, which has no single control to land on.

Constructors

Link copied to clipboard
constructor(title: StringResource, description: StringResource?, route: Route, screenTitle: StringResource, keywords: StringResource? = null, fieldKey: String? = null, isAppLocal: Boolean = false)

Properties

Link copied to clipboard
val description: StringResource?
Link copied to clipboard
Link copied to clipboard
val id: String

The title's resource name plus the destination. Unique across the catalog, which the results list keys on.

Link copied to clipboard

True for settings that belong to this phone rather than to a radio, which a remote session must not offer.

Link copied to clipboard
val keywords: StringResource?
Link copied to clipboard
Link copied to clipboard
val screenTitle: StringResource
Link copied to clipboard
val title: StringResource