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.



20052
20053
20054
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20052

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:



20002
20003
20004
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20002

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:



20009
20010
20011
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20009

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) 


20014
20015
20016
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20014

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


20020
20021
20022
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20020

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) 


20025
20026
20027
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20025

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


20030
20031
20032
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20030

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) 


20035
20036
20037
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20035

def name
  @name
end

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

Corresponds to the JSON property onChange

Returns:



20040
20041
20042
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20040

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


20045
20046
20047
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20045

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


20050
20051
20052
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20050

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20057
20058
20059
20060
20061
20062
20063
20064
20065
20066
20067
20068
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20057

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