appsuite_media_api_common_core/com.tomtom.ivi.appsuite.media.api.common.core.actions/BrowserAction

BrowserAction

@IviExperimental(reasons = [])
open class BrowserAction<T>(val id: String, val arguments: Bundle? = null, val resultConverter: (Bundle?) -> BrowserActionResult.Success<T>)

A browsing action which can be sent (or launched) to the current media source client so it can be performed.

The difference between BrowserAction and Action is defined mainly by the media source implementation. Browser actions are sent by calling the SourceClient.coLaunchBrowserAction method. And are usually related to modification (not playback) of the content. For example, following or unfollowing an entire media collection or downloading an item for offline playback is a BrowserAction.

See also

Parameters

T

Type of the optional data returned by BrowserActionResult.Success.

id

The ID of this action. Unique for the media source it refers to. Must not be blank.

arguments

Optional arguments for this action. Specific to the given id.

resultConverter

Converter function to parse the Bundle returned by the source in case of successful result into the typed value.

Constructors

Link copied to clipboard
fun <T> BrowserAction(id: String, arguments: Bundle? = null, resultConverter: (Bundle?) -> BrowserActionResult.Success<T>)

Properties

Link copied to clipboard
val arguments: Bundle? = null
Link copied to clipboard
val id: String
Link copied to clipboard