Class: Google::Apis::CloudsearchV1::FormAction

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FormAction

Returns a new instance of FormAction.



7907
7908
7909
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7907

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

Instance Attribute Details

#action_method_name ⇒ String

Apps script function that should be invoked in the developer's apps script when the containing element is clicked/activated. Corresponds to the JSON property actionMethodName

Returns:

  • (String) 


7876
7877
7878
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7876

def action_method_name
  @action_method_name
end

#load_indicator ⇒ String

Corresponds to the JSON property loadIndicator

Returns:

  • (String) 


7881
7882
7883
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7881

def load_indicator
  @load_indicator
end

#parameters ⇒ Array<Google::Apis::CloudsearchV1::ActionParameter>

Corresponds to the JSON property parameters

Returns:



7886
7887
7888
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7886

def parameters
  @parameters
end

#persist_values ⇒ Boolean Also known as: persist_values?

Indicates whether form values persist after the action. When false, the Apps Script is responsible for persisting values, by setting any form field values using the formInputs in the event. Disabling this behavior can be used if the add-on needs the ability to clear form fields, for example, as with persistent values, there is no means for clearing existing values. When disabling persistent values, it is strongly recommended that the add-on use LoadIndicator.SPINNER for all events, as this locks the UI to ensure no changes are made by the user while the action is being processed. When using LoadIndicator.NONE for any of the actions, persistent values are recommended, as it ensures that any changes made by the user after form / on change actions are sent to the server are not overwritten by the response. Persistent values disabled by default. While we recommend persistent values be used in the typical use case, we do not enable by default, as doing so would change the current behavior of existing add-ons in prod. Corresponds to the JSON property persistValues

Returns:

  • (Boolean) 


7904
7905
7906
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7904

def persist_values
  @persist_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7912
7913
7914
7915
7916
7917
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7912

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