androidx.compose.remote.creation.compose.action

Interfaces

Action

A RemoteCompose frontend model of Actions that can be converted to RemoteCompose operations.

Composables

pendingIntentAction

Create a PendingIntentAction to send the PendingIntent when invoked.

Top-level functions summary

Action
<T : Any?> ValueChange(
    remoteState: MutableRemoteState<T>,
    updatedValue: RemoteState<T>
)

Creates an Action that updates the value of a MutableRemoteState to a new RemoteState.

Action
combinedAction(vararg actions: Action)

Creates an action that's a composite of multiple actions.

Action

Creates an Action that triggers a named action on the host.

Action

Creates an Action that triggers a named action on the host with a float value.

Action

Creates an Action that triggers a named action on the host with an int value.

Action

Creates an Action that triggers a named action on the host with a string value.

Top-level functions

fun <T : Any?> ValueChange(
    remoteState: MutableRemoteState<T>,
    updatedValue: RemoteState<T>
): Action

Creates an Action that updates the value of a MutableRemoteState to a new RemoteState.

Parameters
remoteState: MutableRemoteState<T>

The mutable remote state to be updated.

updatedValue: RemoteState<T>

The new remote state value to apply.

Returns
Action

An Action representing the value change.

fun combinedAction(vararg actions: Action): Action

Creates an action that's a composite of multiple actions.

Parameters
vararg actions: Action

The actions to combine.

fun hostAction(name: RemoteString): Action

Creates an Action that triggers a named action on the host.

Parameters
name: RemoteString

The name of the action.

fun hostAction(name: RemoteString, value: RemoteFloat): Action

Creates an Action that triggers a named action on the host with a float value.

Parameters
name: RemoteString

The name of the action.

value: RemoteFloat

The float value to pass with the action.

fun hostAction(name: RemoteString, value: RemoteInt): Action

Creates an Action that triggers a named action on the host with an int value.

Parameters
name: RemoteString

The name of the action.

value: RemoteInt

The int value to pass with the action.

fun hostAction(name: RemoteString, value: RemoteString): Action

Creates an Action that triggers a named action on the host with a string value.

Parameters
name: RemoteString

The name of the action.

value: RemoteString

The string value to pass with the action.