Class: Google::Apis::CloudsearchV1::TextField

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

Returns a new instance of TextField.



16561
16562
16563
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16561

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

Instance Attribute Details

#auto_complete ⇒ Google::Apis::CloudsearchV1::AutoComplete

The initial set of auto complete items without any user input. Corresponds to the JSON property autoComplete

Returns:



16511
16512
16513
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16511

def auto_complete
  @auto_complete
end

#auto_complete_callback ⇒ Google::Apis::CloudsearchV1::FormAction

The refresh function which returns AutoComplete based on the user's input text. If the callback is not specified, auto complete will be purely done in client side based on the auto_complete items. Corresponds to the JSON property autoCompleteCallback

Returns:



16518
16519
16520
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16518

def auto_complete_callback
  @auto_complete_callback
end

#auto_complete_multiple_selections ⇒ Boolean Also known as: auto_complete_multiple_selections?

When set to true, a user can input multiple auto-complet items. Corresponds to the JSON property autoCompleteMultipleSelections

Returns:

  • (Boolean) 


16523
16524
16525
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16523

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


16529
16530
16531
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16529

def hint_text
  @hint_text
end

#label ⇒ String

One of label or hint_text is required to be specified by the developers. Corresponds to the JSON property label

Returns:

  • (String) 


16534
16535
16536
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16534

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


16539
16540
16541
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16539

def max_lines
  @max_lines
end

#name ⇒ String

The name of the text field which is will be used in FormInput. Corresponds to the JSON property name

Returns:

  • (String) 


16544
16545
16546
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16544

def name
  @name
end

#on_change ⇒ Google::Apis::CloudsearchV1::FormAction

Corresponds to the JSON property onChange

Returns:



16549
16550
16551
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16549

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


16554
16555
16556
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16554

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


16559
16560
16561
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16559

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16566

def update!(**args)
  @auto_complete = args[:auto_complete] if args.key?(:auto_complete)
  @auto_complete_callback = args[:auto_complete_callback] if args.key?(:auto_complete_callback)
  @auto_complete_multiple_selections = args[:auto_complete_multiple_selections] if args.key?(:auto_complete_multiple_selections)
  @hint_text = args[:hint_text] if args.key?(:hint_text)
  @label = args[:label] if args.key?(:label)
  @max_lines = args[:max_lines] if args.key?(:max_lines)
  @name = args[:name] if args.key?(:name)
  @on_change = args[:on_change] if args.key?(:on_change)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
end