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

Package-level declarations

An Action is a command which can be sent (or launched) to the current source to be performed. Actions include standard media-related operations, but also operations specific to a single source, such as the action to "like" a track.

Check out Action and StandardActionId for further reference.

Types

Link copied to clipboard
@IviExperimental(reasons = [])
open class Action(val id: String, val arguments: Bundle? = null, val icon: Action.CustomActionIcon? = null) : Parcelable

A command which can be sent (or launched) to the current source so it can be performed. This is a raw command, suitable to be transmitted over IPC.

Link copied to clipboard
@IviExperimental(reasons = [])
interface ActionId

Interface for text IDs to represent Actions. ActionIds for standard actions are recognized by the stock IVI media service. All others are merely passed on to the active media source.

Link copied to clipboard
@IviExperimental(reasons = [])
typealias ActionList = List<Action>

Type alias for a list of Actions.

Link copied to clipboard
@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.

Link copied to clipboard
@IviExperimental(reasons = [])
sealed class BrowserActionResult<T>

Result of a launched BrowserAction.

Link copied to clipboard
@IviExperimental(reasons = [])
typealias LiveDataActionList = LiveData<ActionList>

Type alias for a LiveData containing a list of Actions.

Functions

Link copied to clipboard
@IviExperimental(reasons = [])
fun LiveDataActionList?.getFirstActionByIdOrNull(vararg actions: Action): LiveData<Action?>

Extension function to determine whether a LiveData list of Actions contains at least one of the given actions. It compares actions by their Action.ids. If such action exists it will be returned. Otherwise, it returns null.

Link copied to clipboard
@IviExperimental(reasons = [])
fun LiveDataActionList?.hasAnyAction(vararg actions: Action): LiveData<Boolean>

Extension function to determine whether a LiveData list of Actions contains at least one of the given actions. It compares Action.id and Action.arguments, whereas it does not compare Action.icon since it is not necessary.

Link copied to clipboard
@IviExperimental(reasons = [])
fun LiveDataActionList?.hasAnyActionId(vararg actionIds: String): LiveData<Boolean>

Extension function to determine whether a LiveData list of Actions contains at least one Action.id of the given actionIds.

@IviExperimental(reasons = [])
fun Collection<Action>.hasAnyActionId(vararg actionIds: String): Boolean

Extension function to determine whether a Collection of Actions contains at least one Action.id of the given actionIds.