Skip to content

/AWS1/CL_AMUACTIONPARAMETERS

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

io_type TYPE REF TO /AWS1/CL_AMUCOMPONENTPROPERTY /AWS1/CL_AMUCOMPONENTPROPERTY

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

io_url TYPE REF TO /AWS1/CL_AMUCOMPONENTPROPERTY /AWS1/CL_AMUCOMPONENTPROPERTY

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

io_anchor TYPE REF TO /AWS1/CL_AMUCOMPONENTPROPERTY /AWS1/CL_AMUCOMPONENTPROPERTY

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

io_target TYPE REF TO /AWS1/CL_AMUCOMPONENTPROPERTY /AWS1/CL_AMUCOMPONENTPROPERTY

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

io_global TYPE REF TO /AWS1/CL_AMUCOMPONENTPROPERTY /AWS1/CL_AMUCOMPONENTPROPERTY

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

iv_model TYPE /AWS1/AMUSTRING /AWS1/AMUSTRING

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

io_id TYPE REF TO /AWS1/CL_AMUCOMPONENTPROPERTY /AWS1/CL_AMUCOMPONENTPROPERTY

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

it_fields TYPE /AWS1/CL_AMUCOMPONENTPROPERTY=>TT_COMPONENTPROPERTIES TT_COMPONENTPROPERTIES

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.

io_state TYPE REF TO /AWS1/CL_AMUMUTATIONACTETSTA00 /AWS1/CL_AMUMUTATIONACTETSTA00

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


Queryable Attributes

type

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

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE

url

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

Accessible with the following methods

Method Description
GET_URL() Getter for URL

anchor

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

Accessible with the following methods

Method Description
GET_ANCHOR() Getter for ANCHOR

target

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

Accessible with the following methods

Method Description
GET_TARGET() Getter for TARGET

global

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

Accessible with the following methods

Method Description
GET_GLOBAL() Getter for GLOBAL

model

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

Accessible with the following methods

Method Description
GET_MODEL() Getter for MODEL, with configurable default
ASK_MODEL() Getter for MODEL w/ exceptions if field has no value
HAS_MODEL() Determine if MODEL has a value

id

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

Accessible with the following methods

Method Description
GET_ID() Getter for ID

fields

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.

Accessible with the following methods

Method Description
GET_FIELDS() Getter for FIELDS, with configurable default
ASK_FIELDS() Getter for FIELDS w/ exceptions if field has no value
HAS_FIELDS() Determine if FIELDS has a value

state

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

Accessible with the following methods

Method Description
GET_STATE() Getter for STATE