Class: Google::Apis::CloudsearchV1::AppsDynamiteSharedTextInput

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

A text input is a UI item where users can input text. A text input can also have an onChange action and suggestions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AppsDynamiteSharedTextInput

Returns a new instance of AppsDynamiteSharedTextInput.



3537
3538
3539
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3537

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

Instance Attribute Details

#auto_complete_action ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedAction

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. Corresponds to the JSON property autoCompleteAction

Returns:



3498
3499
3500
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3498

def auto_complete_action
  @auto_complete_action
end

#hint_text ⇒ String

The hint text. Corresponds to the JSON property hintText

Returns:

  • (String) 


3503
3504
3505
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3503

def hint_text
  @hint_text
end

#initial_suggestions ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedSuggestions

A container wrapping elements necessary for showing suggestion items used in text input autocomplete. Corresponds to the JSON property initialSuggestions

Returns:



3509
3510
3511
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3509

def initial_suggestions
  @initial_suggestions
end

#label ⇒ String

At least one of label and hintText must be specified. Corresponds to the JSON property label

Returns:

  • (String) 


3514
3515
3516
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3514

def label
  @label
end

#name ⇒ String

The name of the text input which is used in formInput. Corresponds to the JSON property name

Returns:

  • (String) 


3519
3520
3521
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3519

def name
  @name
end

#on_change_action ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedAction

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. Corresponds to the JSON property onChangeAction

Returns:



3525
3526
3527
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3525

def on_change_action
  @on_change_action
end

#type ⇒ String

The style of the text, for example, a single line or multiple lines. Corresponds to the JSON property type

Returns:

  • (String) 


3530
3531
3532
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3530

def type
  @type
end

#value ⇒ String

The default value when there is no input from the user. Corresponds to the JSON property value

Returns:

  • (String) 


3535
3536
3537
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3535

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3542

def update!(**args)
  @auto_complete_action = args[:auto_complete_action] if args.key?(:auto_complete_action)
  @hint_text = args[:hint_text] if args.key?(:hint_text)
  @initial_suggestions = args[:initial_suggestions] if args.key?(:initial_suggestions)
  @label = args[:label] if args.key?(:label)
  @name = args[:name] if args.key?(:name)
  @on_change_action = args[:on_change_action] if args.key?(:on_change_action)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
end