Class: Google::Apis::ChatV1::GoogleAppsCardV1Action

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1Action

Returns a new instance of GoogleAppsCardV1Action.



970
971
972
 
# File 'lib/google/apis/chat_v1/classes.rb', line 970

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#function ⇒ String

A custom function to invoke when the containing element is clicked or othrwise activated. For example usage, see Create interactive cards. Corresponds to the JSON property function

Returns:

  • (String) 


924
925
926
 
# File 'lib/google/apis/chat_v1/classes.rb', line 924

def function
  @function
end

#interaction ⇒ String

Optional. Required when opening a dialog. What to do in response to an interaction with a user, such as a user clicking button on 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 is not shown. Supported by Chat apps, but not Google Workspace Add-ons. If specified for an add-on, the entire card is stripped and nothing is shown in the client. Corresponds to the JSON property interaction

Returns:

  • (String) 


938
939
940
 
# File 'lib/google/apis/chat_v1/classes.rb', line 938

def interaction
  @interaction
end

#load_indicator ⇒ String

Specifies the loading indicator that the action displays while making the call to the action. Corresponds to the JSON property loadIndicator

Returns:

  • (String) 


944
945
946
 
# File 'lib/google/apis/chat_v1/classes.rb', line 944

def load_indicator
  @load_indicator
end

#parameters ⇒ Array<Google::Apis::ChatV1::GoogleAppsCardV1ActionParameter>

List of action parameters. Corresponds to the JSON property parameters

Returns:



949
950
951
 
# File 'lib/google/apis/chat_v1/classes.rb', line 949

def parameters
  @parameters
end

#persist_values ⇒ Boolean Also known as: persist_values?

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. Corresponds to the JSON property persistValues

Returns:

  • (Boolean) 


967
968
969
 
# File 'lib/google/apis/chat_v1/classes.rb', line 967

def persist_values
  @persist_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



975
976
977
978
979
980
981
 
# File 'lib/google/apis/chat_v1/classes.rb', line 975

def update!(**args)
  @function = args[:function] if args.key?(:function)
  @interaction = args[:interaction] if args.key?(:interaction)
  @load_indicator = args[:load_indicator] if args.key?(:load_indicator)
  @parameters = args[:parameters] if args.key?(:parameters)
  @persist_values = args[:persist_values] if args.key?(:persist_values)
end