Class: Google::Apps::Card::V1::Action

Inherits:

Object

Object
Google::Apps::Card::V1::Action

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/apps/card/v1/card.rb

Overview

An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server.

Google Workspace add-ons and Chat apps:

Defined Under Namespace

Modules: Interaction, LoadIndicator Classes: ActionParameter

Instance Attribute Summary collapse

#all_widgets_are_required ⇒ ::Boolean
Optional.
#function ⇒ ::String
A custom function to invoke when the containing element is clicked or otherwise activated.
#interaction ⇒ ::Google::Apps::Card::V1::Action::Interaction
Optional.
#load_indicator ⇒ ::Google::Apps::Card::V1::Action::LoadIndicator
Specifies the loading indicator that the action displays while making the call to the action.
#parameters ⇒ ::Array<::Google::Apps::Card::V1::Action::ActionParameter>
List of action parameters.
#persist_values ⇒ ::Boolean
Indicates whether form values persist after the action.
#required_widgets ⇒ ::Array<::String>
Optional.

Instance Attribute Details

#all_widgets_are_required ⇒ `::Boolean`

Returns Optional. If this is true, then all widgets are considered required by this action.

Google Workspace add-ons and Chat apps:.

Returns:

(::Boolean) —
Optional. If this is true, then all widgets are considered required by this action.

Google Workspace add-ons and Chat apps:

# File 'proto_docs/google/apps/card/v1/card.rb', line 2423

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of string parameters to supply when the action method is invoked.
  # For example, consider three snooze buttons: snooze now, snooze one day,
  # or snooze next week. You might use `action method = snooze()`, passing the
  # snooze type and snooze time in the list of string parameters.
  #
  # To learn more, see
  # [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  # @!attribute [rw] key
  #   @return [::String]
  #     The name of the parameter for the action script.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the parameter.
  class ActionParameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the loading indicator that the action displays while
  # making the call to the action.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module LoadIndicator
    # Displays a spinner to indicate that content is loading.
    SPINNER = 0

    # Nothing is displayed.
    NONE = 1
  end

  # Optional. Required when opening a
  # [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # What to do in response to an interaction with a user, such as a user
  # clicking a button in a card message.
  #
  # If unspecified, the app responds by executing an `action`—like opening a
  # link or running a function—as normal.
  #
  # By specifying an `interaction`, the app can respond in special interactive
  # ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
  # open a [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # When specified, a loading indicator isn't shown. If specified for
  # an add-on, the entire card is stripped and nothing is shown in the client.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Interaction
    # Default value. The `action` executes as normal.
    INTERACTION_UNSPECIFIED = 0

    # Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
    # windowed, card-based interface that Chat apps use to interact with users.
    #
    # Only supported by Chat apps in response to button-clicks on card
    # messages. If specified for
    # an add-on, the entire card is stripped and nothing is shown in the
    # client.
    #
    # [Google Chat apps](https://developers.google.com/workspace/chat):
    OPEN_DIALOG = 1
  end
end

#function ⇒ `::String`

Returns A custom function to invoke when the containing element is clicked or otherwise activated.

For example usage, see Read form data.

Returns:

(::String) —
A custom function to invoke when the containing element is clicked or otherwise activated.

For example usage, see Read form data.

# File 'proto_docs/google/apps/card/v1/card.rb', line 2423

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of string parameters to supply when the action method is invoked.
  # For example, consider three snooze buttons: snooze now, snooze one day,
  # or snooze next week. You might use `action method = snooze()`, passing the
  # snooze type and snooze time in the list of string parameters.
  #
  # To learn more, see
  # [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  # @!attribute [rw] key
  #   @return [::String]
  #     The name of the parameter for the action script.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the parameter.
  class ActionParameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the loading indicator that the action displays while
  # making the call to the action.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module LoadIndicator
    # Displays a spinner to indicate that content is loading.
    SPINNER = 0

    # Nothing is displayed.
    NONE = 1
  end

  # Optional. Required when opening a
  # [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # What to do in response to an interaction with a user, such as a user
  # clicking a button in a card message.
  #
  # If unspecified, the app responds by executing an `action`—like opening a
  # link or running a function—as normal.
  #
  # By specifying an `interaction`, the app can respond in special interactive
  # ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
  # open a [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # When specified, a loading indicator isn't shown. If specified for
  # an add-on, the entire card is stripped and nothing is shown in the client.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Interaction
    # Default value. The `action` executes as normal.
    INTERACTION_UNSPECIFIED = 0

    # Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
    # windowed, card-based interface that Chat apps use to interact with users.
    #
    # Only supported by Chat apps in response to button-clicks on card
    # messages. If specified for
    # an add-on, the entire card is stripped and nothing is shown in the
    # client.
    #
    # [Google Chat apps](https://developers.google.com/workspace/chat):
    OPEN_DIALOG = 1
  end
end

#interaction ⇒ `::Google::Apps::Card::V1::Action::Interaction`

Returns Optional. Required when opening a dialog.

What to do in response to an interaction with a user, such as a user clicking a button in a card message.

If unspecified, the app responds by executing an action—like opening a link or running a function—as normal.

By specifying an interaction, the app can respond in special interactive ways. For example, by setting interaction to OPEN_DIALOG, the app can open a dialog. When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

Google Chat apps:.

Returns:

(::Google::Apps::Card::V1::Action::Interaction) —
Optional. Required when opening a dialog.

What to do in response to an interaction with a user, such as a user clicking a button in a card message.

If unspecified, the app responds by executing an action—like opening a link or running a function—as normal.

By specifying an interaction, the app can respond in special interactive ways. For example, by setting interaction to OPEN_DIALOG, the app can open a dialog. When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client.

Google Chat apps:

# File 'proto_docs/google/apps/card/v1/card.rb', line 2423

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of string parameters to supply when the action method is invoked.
  # For example, consider three snooze buttons: snooze now, snooze one day,
  # or snooze next week. You might use `action method = snooze()`, passing the
  # snooze type and snooze time in the list of string parameters.
  #
  # To learn more, see
  # [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  # @!attribute [rw] key
  #   @return [::String]
  #     The name of the parameter for the action script.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the parameter.
  class ActionParameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the loading indicator that the action displays while
  # making the call to the action.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module LoadIndicator
    # Displays a spinner to indicate that content is loading.
    SPINNER = 0

    # Nothing is displayed.
    NONE = 1
  end

  # Optional. Required when opening a
  # [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # What to do in response to an interaction with a user, such as a user
  # clicking a button in a card message.
  #
  # If unspecified, the app responds by executing an `action`—like opening a
  # link or running a function—as normal.
  #
  # By specifying an `interaction`, the app can respond in special interactive
  # ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
  # open a [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # When specified, a loading indicator isn't shown. If specified for
  # an add-on, the entire card is stripped and nothing is shown in the client.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Interaction
    # Default value. The `action` executes as normal.
    INTERACTION_UNSPECIFIED = 0

    # Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
    # windowed, card-based interface that Chat apps use to interact with users.
    #
    # Only supported by Chat apps in response to button-clicks on card
    # messages. If specified for
    # an add-on, the entire card is stripped and nothing is shown in the
    # client.
    #
    # [Google Chat apps](https://developers.google.com/workspace/chat):
    OPEN_DIALOG = 1
  end
end

#load_indicator ⇒ `::Google::Apps::Card::V1::Action::LoadIndicator`

Returns Specifies the loading indicator that the action displays while making the call to the action.

Returns:

(::Google::Apps::Card::V1::Action::LoadIndicator) —
Specifies the loading indicator that the action displays while making the call to the action.

# File 'proto_docs/google/apps/card/v1/card.rb', line 2423

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of string parameters to supply when the action method is invoked.
  # For example, consider three snooze buttons: snooze now, snooze one day,
  # or snooze next week. You might use `action method = snooze()`, passing the
  # snooze type and snooze time in the list of string parameters.
  #
  # To learn more, see
  # [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  # @!attribute [rw] key
  #   @return [::String]
  #     The name of the parameter for the action script.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the parameter.
  class ActionParameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the loading indicator that the action displays while
  # making the call to the action.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module LoadIndicator
    # Displays a spinner to indicate that content is loading.
    SPINNER = 0

    # Nothing is displayed.
    NONE = 1
  end

  # Optional. Required when opening a
  # [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # What to do in response to an interaction with a user, such as a user
  # clicking a button in a card message.
  #
  # If unspecified, the app responds by executing an `action`—like opening a
  # link or running a function—as normal.
  #
  # By specifying an `interaction`, the app can respond in special interactive
  # ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
  # open a [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # When specified, a loading indicator isn't shown. If specified for
  # an add-on, the entire card is stripped and nothing is shown in the client.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Interaction
    # Default value. The `action` executes as normal.
    INTERACTION_UNSPECIFIED = 0

    # Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
    # windowed, card-based interface that Chat apps use to interact with users.
    #
    # Only supported by Chat apps in response to button-clicks on card
    # messages. If specified for
    # an add-on, the entire card is stripped and nothing is shown in the
    # client.
    #
    # [Google Chat apps](https://developers.google.com/workspace/chat):
    OPEN_DIALOG = 1
  end
end

#parameters ⇒ `::Array<::Google::Apps::Card::V1::Action::ActionParameter>`

Returns List of action parameters.

Returns:

(::Array<::Google::Apps::Card::V1::Action::ActionParameter>) —
List of action parameters.

# File 'proto_docs/google/apps/card/v1/card.rb', line 2423

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of string parameters to supply when the action method is invoked.
  # For example, consider three snooze buttons: snooze now, snooze one day,
  # or snooze next week. You might use `action method = snooze()`, passing the
  # snooze type and snooze time in the list of string parameters.
  #
  # To learn more, see
  # [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  # @!attribute [rw] key
  #   @return [::String]
  #     The name of the parameter for the action script.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the parameter.
  class ActionParameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the loading indicator that the action displays while
  # making the call to the action.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module LoadIndicator
    # Displays a spinner to indicate that content is loading.
    SPINNER = 0

    # Nothing is displayed.
    NONE = 1
  end

  # Optional. Required when opening a
  # [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # What to do in response to an interaction with a user, such as a user
  # clicking a button in a card message.
  #
  # If unspecified, the app responds by executing an `action`—like opening a
  # link or running a function—as normal.
  #
  # By specifying an `interaction`, the app can respond in special interactive
  # ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
  # open a [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # When specified, a loading indicator isn't shown. If specified for
  # an add-on, the entire card is stripped and nothing is shown in the client.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Interaction
    # Default value. The `action` executes as normal.
    INTERACTION_UNSPECIFIED = 0

    # Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
    # windowed, card-based interface that Chat apps use to interact with users.
    #
    # Only supported by Chat apps in response to button-clicks on card
    # messages. If specified for
    # an add-on, the entire card is stripped and nothing is shown in the
    # client.
    #
    # [Google Chat apps](https://developers.google.com/workspace/chat):
    OPEN_DIALOG = 1
  end
end

#persist_values ⇒ `::Boolean`

Returns Indicates whether form values persist after the action. The default value is false.

If true, form values remain after the action is triggered. To let the user make changes while the action is being processed, set LoadIndicator to NONE. For card messages in Chat apps, you must also set the action's ResponseType to UPDATE_MESSAGE and use the same card_id from the card that contained the action.

If false, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set LoadIndicator to SPINNER.

Returns:

(::Boolean) —
Indicates whether form values persist after the action. The default value is false.

If true, form values remain after the action is triggered. To let the user make changes while the action is being processed, set LoadIndicator to NONE. For card messages in Chat apps, you must also set the action's ResponseType to UPDATE_MESSAGE and use the same card_id from the card that contained the action.

If false, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set LoadIndicator to SPINNER.

# File 'proto_docs/google/apps/card/v1/card.rb', line 2423

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of string parameters to supply when the action method is invoked.
  # For example, consider three snooze buttons: snooze now, snooze one day,
  # or snooze next week. You might use `action method = snooze()`, passing the
  # snooze type and snooze time in the list of string parameters.
  #
  # To learn more, see
  # [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  # @!attribute [rw] key
  #   @return [::String]
  #     The name of the parameter for the action script.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the parameter.
  class ActionParameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the loading indicator that the action displays while
  # making the call to the action.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module LoadIndicator
    # Displays a spinner to indicate that content is loading.
    SPINNER = 0

    # Nothing is displayed.
    NONE = 1
  end

  # Optional. Required when opening a
  # [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # What to do in response to an interaction with a user, such as a user
  # clicking a button in a card message.
  #
  # If unspecified, the app responds by executing an `action`—like opening a
  # link or running a function—as normal.
  #
  # By specifying an `interaction`, the app can respond in special interactive
  # ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
  # open a [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # When specified, a loading indicator isn't shown. If specified for
  # an add-on, the entire card is stripped and nothing is shown in the client.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Interaction
    # Default value. The `action` executes as normal.
    INTERACTION_UNSPECIFIED = 0

    # Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
    # windowed, card-based interface that Chat apps use to interact with users.
    #
    # Only supported by Chat apps in response to button-clicks on card
    # messages. If specified for
    # an add-on, the entire card is stripped and nothing is shown in the
    # client.
    #
    # [Google Chat apps](https://developers.google.com/workspace/chat):
    OPEN_DIALOG = 1
  end
end

#required_widgets ⇒ `::Array<::String>`

Returns Optional. Fill this list with the names of widgets that this Action needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted.

Google Workspace add-ons and Chat apps:.

Returns:

(::Array<::String>) —
Optional. Fill this list with the names of widgets that this Action needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted.

Google Workspace add-ons and Chat apps:

# File 'proto_docs/google/apps/card/v1/card.rb', line 2423

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of string parameters to supply when the action method is invoked.
  # For example, consider three snooze buttons: snooze now, snooze one day,
  # or snooze next week. You might use `action method = snooze()`, passing the
  # snooze type and snooze time in the list of string parameters.
  #
  # To learn more, see
  # [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  # @!attribute [rw] key
  #   @return [::String]
  #     The name of the parameter for the action script.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the parameter.
  class ActionParameter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the loading indicator that the action displays while
  # making the call to the action.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module LoadIndicator
    # Displays a spinner to indicate that content is loading.
    SPINNER = 0

    # Nothing is displayed.
    NONE = 1
  end

  # Optional. Required when opening a
  # [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # What to do in response to an interaction with a user, such as a user
  # clicking a button in a card message.
  #
  # If unspecified, the app responds by executing an `action`—like opening a
  # link or running a function—as normal.
  #
  # By specifying an `interaction`, the app can respond in special interactive
  # ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
  # open a [dialog](https://developers.google.com/workspace/chat/dialogs).
  #
  # When specified, a loading indicator isn't shown. If specified for
  # an add-on, the entire card is stripped and nothing is shown in the client.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Interaction
    # Default value. The `action` executes as normal.
    INTERACTION_UNSPECIFIED = 0

    # Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a
    # windowed, card-based interface that Chat apps use to interact with users.
    #
    # Only supported by Chat apps in response to button-clicks on card
    # messages. If specified for
    # an add-on, the entire card is stripped and nothing is shown in the
    # client.
    #
    # [Google Chat apps](https://developers.google.com/workspace/chat):
    OPEN_DIALOG = 1
  end
end

Class: Google::Apps::Card::V1::Action

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#all_widgets_are_required ⇒ ::Boolean

#function ⇒ ::String

#interaction ⇒ ::Google::Apps::Card::V1::Action::Interaction

#load_indicator ⇒ ::Google::Apps::Card::V1::Action::LoadIndicator

#parameters ⇒ ::Array<::Google::Apps::Card::V1::Action::ActionParameter>

#persist_values ⇒ ::Boolean

#required_widgets ⇒ ::Array<::String>

#all_widgets_are_required ⇒ `::Boolean`

#function ⇒ `::String`

#interaction ⇒ `::Google::Apps::Card::V1::Action::Interaction`

#load_indicator ⇒ `::Google::Apps::Card::V1::Action::LoadIndicator`

#parameters ⇒ `::Array<::Google::Apps::Card::V1::Action::ActionParameter>`

#persist_values ⇒ `::Boolean`

#required_widgets ⇒ `::Array<::String>`