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.



2453
2454
2455
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2453

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

Instance Attribute Details

#functionString

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

Returns:

  • (String)


2420
2421
2422
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2420

def function
  @function
end

#interactionString

Corresponds to the JSON property interaction

Returns:

  • (String)


2425
2426
2427
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2425

def interaction
  @interaction
end

#load_indicatorString

Corresponds to the JSON property loadIndicator

Returns:

  • (String)


2430
2431
2432
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2430

def load_indicator
  @load_indicator
end

#parametersArray<Google::Apis::CloudsearchV1::AppsDynamiteStorageActionActionParameter>

List of action parameters. Corresponds to the JSON property parameters



2435
2436
2437
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2435

def parameters
  @parameters
end

#persist_valuesBoolean 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)


2450
2451
2452
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2450

def persist_values
  @persist_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2458
2459
2460
2461
2462
2463
2464
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2458

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