Class: Google::Apis::CloudsearchV1::AppsDynamiteStorageAction

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

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) ⇒ AppsDynamiteStorageAction

Returns a new instance of AppsDynamiteStorageAction.



2725
2726
2727
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2725

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) 


2692
2693
2694
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2692

def function
  @function
end

#interaction ⇒ String

Corresponds to the JSON property interaction

Returns:

  • (String) 


2697
2698
2699
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2697

def interaction
  @interaction
end

#load_indicator ⇒ String

Corresponds to the JSON property loadIndicator

Returns:

  • (String) 


2702
2703
2704
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2702

def load_indicator
  @load_indicator
end

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

List of action parameters. Corresponds to the JSON property parameters

Returns:



2707
2708
2709
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2707

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

Returns:

  • (Boolean) 


2722
2723
2724
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2722

def persist_values
  @persist_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2730
2731
2732
2733
2734
2735
2736
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2730

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