Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AmplifyUiBuilder.Types.ActionParameters

Description

Synopsis

data ActionParameters = ActionParameters' {
- anchor :: Maybe ComponentProperty
- fields :: Maybe (HashMap Text ComponentProperty)
- global :: Maybe ComponentProperty
- id :: Maybe ComponentProperty
- model :: Maybe Text
- state :: Maybe MutationActionSetStateParameter
- target :: Maybe ComponentProperty
- type' :: Maybe ComponentProperty
- url :: Maybe ComponentProperty
}
newActionParameters :: ActionParameters
actionParameters_anchor :: Lens' ActionParameters (Maybe ComponentProperty)
actionParameters_fields :: Lens' ActionParameters (Maybe (HashMap Text ComponentProperty))
actionParameters_global :: Lens' ActionParameters (Maybe ComponentProperty)
actionParameters_id :: Lens' ActionParameters (Maybe ComponentProperty)
actionParameters_model :: Lens' ActionParameters (Maybe Text)
actionParameters_state :: Lens' ActionParameters (Maybe MutationActionSetStateParameter)
actionParameters_target :: Lens' ActionParameters (Maybe ComponentProperty)
actionParameters_type :: Lens' ActionParameters (Maybe ComponentProperty)
actionParameters_url :: Lens' ActionParameters (Maybe ComponentProperty)

Documentation

data ActionParameters Source #

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.

See: newActionParameters smart constructor.

Constructors

ActionParameters'

Fields

anchor :: Maybe ComponentProperty
The HTML anchor link to the location to open. Specify this value for a navigation action.
fields :: Maybe (HashMap Text ComponentProperty)
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.
global :: Maybe ComponentProperty
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
id :: Maybe ComponentProperty
The unique ID of the component that the ActionParameters apply to.
model :: Maybe Text
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
state :: Maybe MutationActionSetStateParameter
A key-value pair that specifies the state property name and its initial value.
target :: Maybe ComponentProperty
The element within the same component to modify when the action occurs.
type' :: Maybe ComponentProperty
The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
url :: Maybe ComponentProperty
The URL to the location to open. Specify this value for a navigation action.

Instances

Instances details

FromJSON ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Methods parseJSON :: Value -> Parser ActionParameters # parseJSONList :: Value -> Parser [ActionParameters] #
ToJSON ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Methods toJSON :: ActionParameters -> Value # toEncoding :: ActionParameters -> Encoding # toJSONList :: [ActionParameters] -> Value # toEncodingList :: [ActionParameters] -> Encoding #
Generic ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Associated Types type Rep ActionParameters :: Type -> Type # Methods from :: ActionParameters -> Rep ActionParameters x # to :: Rep ActionParameters x -> ActionParameters #
Read ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Methods readsPrec :: Int -> ReadS ActionParameters # readList :: ReadS [ActionParameters] # readPrec :: ReadPrec ActionParameters # readListPrec :: ReadPrec [ActionParameters] #
Show ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Methods showsPrec :: Int -> ActionParameters -> ShowS # show :: ActionParameters -> String # showList :: [ActionParameters] -> ShowS #
NFData ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Methods rnf :: ActionParameters -> () #
Eq ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Methods (==) :: ActionParameters -> ActionParameters -> Bool # (/=) :: ActionParameters -> ActionParameters -> Bool #
Hashable ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters Methods hashWithSalt :: Int -> ActionParameters -> Int # hash :: ActionParameters -> Int #
type Rep ActionParameters Source #
Instance details Defined in Amazonka.AmplifyUiBuilder.Types.ActionParameters type Rep ActionParameters = D1 ('MetaData "ActionParameters" "Amazonka.AmplifyUiBuilder.Types.ActionParameters" "amazonka-amplifyuibuilder-2.0-KN0MRaPu7dZCAXr3ruBTcC" 'False) (C1 ('MetaCons "ActionParameters'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "anchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentProperty)) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ComponentProperty)))) :: (S1 ('MetaSel ('Just "global") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentProperty)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentProperty)))) :: ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutationActionSetStateParameter))) :: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentProperty)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentProperty)) :: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComponentProperty)))))))

newActionParameters :: ActionParameters Source #

Create a value of ActionParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:anchor:ActionParameters', actionParameters_anchor - The HTML anchor link to the location to open. Specify this value for a navigation action.

$sel:fields:ActionParameters', actionParameters_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.

$sel:global:ActionParameters', actionParameters_global - Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

$sel:id:ActionParameters', actionParameters_id - The unique ID of the component that the ActionParameters apply to.

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

$sel:state:ActionParameters', actionParameters_state - A key-value pair that specifies the state property name and its initial value.

$sel:target:ActionParameters', actionParameters_target - The element within the same component to modify when the action occurs.

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

$sel:url:ActionParameters', actionParameters_url - The URL to the location to open. Specify this value for a navigation action.

actionParameters_anchor :: Lens' ActionParameters (Maybe ComponentProperty) Source #

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

actionParameters_fields :: Lens' ActionParameters (Maybe (HashMap Text ComponentProperty)) Source #

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.

actionParameters_global :: Lens' ActionParameters (Maybe ComponentProperty) Source #

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

actionParameters_id :: Lens' ActionParameters (Maybe ComponentProperty) Source #

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

actionParameters_model :: Lens' ActionParameters (Maybe Text) Source #

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

actionParameters_state :: Lens' ActionParameters (Maybe MutationActionSetStateParameter) Source #

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

actionParameters_target :: Lens' ActionParameters (Maybe ComponentProperty) Source #

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

actionParameters_type :: Lens' ActionParameters (Maybe ComponentProperty) Source #

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

actionParameters_url :: Lens' ActionParameters (Maybe ComponentProperty) Source #

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