androidx.glance.appwidget.action

inline fun <T : ActionCallback> actionRunCallback(
    parameters: ActionParameters = actionParametersOf()
): Action

Creates an Action that executes a given ActionCallback implementation

fun <T : ActionCallback> actionRunCallback(
    callbackClass: Class<T>,
    parameters: ActionParameters = actionParametersOf()
): Action

Creates an Action that executes a given ActionCallback implementation

inline fun <T : BroadcastReceiver> actionSendBroadcast(): Action

Creates an Action that launches the specified BroadcastReceiver when triggered.

fun actionSendBroadcast(componentName: ComponentName): Action

Creates an Action that launches the BroadcastReceiver specified by the given ComponentName.

fun actionSendBroadcast(intent: Intent): Action

Creates an Action that launches a BroadcastReceiver from the given Intent when triggered. The intent should specify a component with Intent.setClass or Intent.setComponent.

fun <T : BroadcastReceiver> actionSendBroadcast(receiver: Class<T>): Action

Creates an Action that launches the specified BroadcastReceiver when triggered.

fun actionSendBroadcast(action: String, componentName: ComponentName? = null): Action

Creates an Action that launches the BroadcastReceiver specified by the given action.

fun actionStartActivity(
    intent: Intent,
    parameters: ActionParameters = actionParametersOf()
): Action

Creates an Action that launches an Activity from the given Intent when triggered. The intent should specify a component with Intent.setClass or Intent.setComponent.

This action is supported by app widgets only.

The given intent will be wrapped in a android.app.PendingIntent. This means that if you create multiple actions with this function, they will be conflated unless the underlying intents are distinct from one another, as defined by Intent.filterEquals. For example, if you create two Intents that target the same Activity but only differ by parameters, they will get conflated (the PendingIntent created by the first call to actionStartActivity will be overwritten by the second). A simple way to avoid this is to set a unique data URI on these intents, so that they are distinct as defined by Intent.filterEquals. There is more information in the class documentation for android.app.PendingIntent. If you do not set one, the library will add a unique URI on the intent you provide here.

@ExperimentalGlanceApi
fun actionStartActivity(
    intent: Intent,
    parameters: ActionParameters = actionParametersOf(),
    activityOptions: Bundle? = null
): Action

Creates an Action that launches an Activity from the given Intent when triggered. The intent should specify a component with Intent.setClass or Intent.setComponent.

This action is supported by app widgets only.

The given intent will be wrapped in a android.app.PendingIntent. This means that if you create multiple actions with this function, they will be conflated unless the underlying intents are distinct from one another, as defined by Intent.filterEquals. For example, if you create two Intents that target the same Activity but only differ by parameters, they will get conflated (the PendingIntent created by the first call to actionStartActivity will be overwritten by the second). A simple way to avoid this is to set a unique data URI on these intents, so that they are distinct as defined by Intent.filterEquals. There is more information in the class documentation for android.app.PendingIntent. If you do not set one, the library will add a unique URI on the intent you provide here.

inline fun <T : Service> actionStartService(isForegroundService: Boolean = false): Action

Creates an Action that launches the specified Service when triggered.

fun actionStartService(
    componentName: ComponentName,
    isForegroundService: Boolean = false
): Action

Creates an Action that launches the Service specified by the given ComponentName.

fun actionStartService(intent: Intent, isForegroundService: Boolean = false): Action

Creates an Action that launches a Service from the given Intent when triggered. The intent should specify a component with Intent.setClass or Intent.setComponent.

fun <T : Service> actionStartService(
    service: Class<T>,
    isForegroundService: Boolean = false
): Action

Creates an Action that launches the specified Service when triggered.

val ToggleableStateKey: ActionParameters.Key<Boolean>

This key is used to access the current checked value for actions that are triggered by compound button interactions (e.g. CheckBox, Switch). This key is used to retrieve the value from the ActionParameters passed to the action.