ComponentActionParameters

data class ComponentActionParameters(val anchor: ComponentProperty? = null, val fields: Map<String, ComponentProperty>? = null, val global: ComponentProperty? = null, val id: ComponentProperty? = null, val model: String? = null, val state: ComponentMutationActionSetStateParameter? = null, val target: ComponentProperty? = null, val type: ComponentProperty? = null, val url: ComponentProperty? = null)

Constructors

Link copied to clipboard
constructor(anchor: ComponentProperty? = null, fields: Map<String, ComponentProperty>? = null, global: ComponentProperty? = null, id: ComponentProperty? = null, model: String? = null, state: ComponentMutationActionSetStateParameter? = null, target: ComponentProperty? = null, type: ComponentProperty? = null, url: ComponentProperty? = null)

Types

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
val id: ComponentProperty? = null

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

Link copied to clipboard
val model: String? = null

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
val type: ComponentProperty? = null

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

Link copied to clipboard
val url: ComponentProperty? = null

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