Class: Aws::AmplifyUIBuilder::Types::ComponentEvent

Inherits:

Struct

• Object
• Struct
• Aws::AmplifyUIBuilder::Types::ComponentEvent

Defined in:

gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb

Overview

Note:

When making an API call, you may pass ComponentEvent data as a hash:

{
  action: "String",
  binding_event: "String",
  parameters: {
    anchor: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        else: {
          # recursive ComponentProperty
        },
        field: "String",
        operand: "String",
        operand_type: "String",
        operator: "String",
        property: "String",
        then: {
          # recursive ComponentProperty
        },
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
    fields: {
      "String" => {
        binding_properties: {
          field: "String",
          property: "String", # required
        },
        bindings: {
          "String" => {
            element: "String", # required
            property: "String", # required
          },
        },
        collection_binding_properties: {
          field: "String",
          property: "String", # required
        },
        component_name: "String",
        concat: [
          {
            # recursive ComponentProperty
          },
        ],
        condition: {
          else: {
            # recursive ComponentProperty
          },
          field: "String",
          operand: "String",
          operand_type: "String",
          operator: "String",
          property: "String",
          then: {
            # recursive ComponentProperty
          },
        },
        configured: false,
        default_value: "String",
        event: "String",
        imported_value: "String",
        model: "String",
        property: "String",
        type: "String",
        user_attribute: "String",
        value: "String",
      },
    },
    global: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        else: {
          # recursive ComponentProperty
        },
        field: "String",
        operand: "String",
        operand_type: "String",
        operator: "String",
        property: "String",
        then: {
          # recursive ComponentProperty
        },
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
    id: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        else: {
          # recursive ComponentProperty
        },
        field: "String",
        operand: "String",
        operand_type: "String",
        operator: "String",
        property: "String",
        then: {
          # recursive ComponentProperty
        },
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
    model: "String",
    state: {
      component_name: "String", # required
      property: "String", # required
      set: { # required
        binding_properties: {
          field: "String",
          property: "String", # required
        },
        bindings: {
          "String" => {
            element: "String", # required
            property: "String", # required
          },
        },
        collection_binding_properties: {
          field: "String",
          property: "String", # required
        },
        component_name: "String",
        concat: [
          {
            # recursive ComponentProperty
          },
        ],
        condition: {
          else: {
            # recursive ComponentProperty
          },
          field: "String",
          operand: "String",
          operand_type: "String",
          operator: "String",
          property: "String",
          then: {
            # recursive ComponentProperty
          },
        },
        configured: false,
        default_value: "String",
        event: "String",
        imported_value: "String",
        model: "String",
        property: "String",
        type: "String",
        user_attribute: "String",
        value: "String",
      },
    },
    target: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        else: {
          # recursive ComponentProperty
        },
        field: "String",
        operand: "String",
        operand_type: "String",
        operator: "String",
        property: "String",
        then: {
          # recursive ComponentProperty
        },
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
    type: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        else: {
          # recursive ComponentProperty
        },
        field: "String",
        operand: "String",
        operand_type: "String",
        operator: "String",
        property: "String",
        then: {
          # recursive ComponentProperty
        },
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
    url: {
      binding_properties: {
        field: "String",
        property: "String", # required
      },
      bindings: {
        "String" => {
          element: "String", # required
          property: "String", # required
        },
      },
      collection_binding_properties: {
        field: "String",
        property: "String", # required
      },
      component_name: "String",
      concat: [
        {
          # recursive ComponentProperty
        },
      ],
      condition: {
        else: {
          # recursive ComponentProperty
        },
        field: "String",
        operand: "String",
        operand_type: "String",
        operator: "String",
        property: "String",
        then: {
          # recursive ComponentProperty
        },
      },
      configured: false,
      default_value: "String",
      event: "String",
      imported_value: "String",
      model: "String",
      property: "String",
      type: "String",
      user_attribute: "String",
      value: "String",
    },
  },
}

Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild. A button click is an example of an event.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action ⇒ String

  The action to perform when a specific event is raised.

• #binding_event ⇒ String

  Binds an event to an action on a component.

• #parameters ⇒ Types::ActionParameters

  Describes information about the action.

Instance Attribute Details

#action ⇒ String

The action to perform when a specific event is raised.

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2170

class ComponentEvent < Struct.new(
  :action,
  :binding_event,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#binding_event ⇒ String

Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.

Returns:

• (String)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2170

class ComponentEvent < Struct.new(
  :action,
  :binding_event,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Types::ActionParameters

Describes information about the action.

Returns:

• (Types::ActionParameters)

# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 2170

class ComponentEvent < Struct.new(
  :action,
  :binding_event,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end