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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1Action

Returns a new instance of GoogleAppsCardV1Action.



940
941
942
 
# File 'lib/google/apis/chat_v1/classes.rb', line 940

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

Instance Attribute Details

#function ⇒ String

Apps Script function to invoke when the containing element is clicked/ activated. Corresponds to the JSON property function

Returns:

  • (String) 


910
911
912
 
# File 'lib/google/apis/chat_v1/classes.rb', line 910

def function
  @function
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) 


916
917
918
 
# File 'lib/google/apis/chat_v1/classes.rb', line 916

def load_indicator
  @load_indicator
end

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

List of action parameters. Corresponds to the JSON property parameters

Returns:



921
922
923
 
# File 'lib/google/apis/chat_v1/classes.rb', line 921

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. When using LoadIndicator.NONE for actions, persist_values = trueis recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If false, the form values are cleared when the action is triggered. When persist_values is set to false, it is strongly recommended that the card use LoadIndicator.SPINNER for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed. Not supported by Google Chat apps. Corresponds to the JSON property persistValues

Returns:

  • (Boolean) 


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

def persist_values
  @persist_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



945
946
947
948
949
950
 
# File 'lib/google/apis/chat_v1/classes.rb', line 945

def update!(**args)
  @function = args[:function] if args.key?(:function)
  @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