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.



16479
16480
16481
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16479

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:



16429
16430
16431
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16429

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:



16436
16437
16438
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16436

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) 


16441
16442
16443
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16441

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


16447
16448
16449
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16447

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) 


16452
16453
16454
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16452

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


16457
16458
16459
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16457

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) 


16462
16463
16464
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16462

def name
  @name
end

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

Corresponds to the JSON property onChange

Returns:



16467
16468
16469
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16467

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


16472
16473
16474
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16472

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


16477
16478
16479
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16477

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16484

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