ActionParameters

Represents the event action configuration for an element of a Component or ComponentChild. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the component.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The HTML anchor link to the location to open. Specify this value for a navigation action.

Link copied to clipboard

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.

Link copied to clipboard

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

Link copied to clipboard

The unique ID of the component that the ActionParameters apply to.

Link copied to clipboard

The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

Link copied to clipboard

A key-value pair that specifies the state property name and its initial value.

Link copied to clipboard

The element within the same component to modify when the action occurs.

Link copied to clipboard

The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

Link copied to clipboard

The URL to the location to open. Specify this value for a navigation action.

Functions

Link copied to clipboard
inline fun copy(block: ActionParameters.Builder.() -> Unit = {}): ActionParameters
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String