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.



16590
16591
16592
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16590

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:



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

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:



16547
16548
16549
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16547

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) 


16552
16553
16554
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16552

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


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

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) 


16563
16564
16565
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16563

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


16568
16569
16570
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16568

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) 


16573
16574
16575
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16573

def name
  @name
end

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

Corresponds to the JSON property onChange

Returns:



16578
16579
16580
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16578

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


16583
16584
16585
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16583

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


16588
16589
16590
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16588

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16595

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