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.



17276
17277
17278
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17276

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:



17226
17227
17228
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17226

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:



17233
17234
17235
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17233

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) 


17238
17239
17240
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17238

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


17244
17245
17246
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17244

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) 


17249
17250
17251
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17249

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


17254
17255
17256
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17254

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) 


17259
17260
17261
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17259

def name
  @name
end

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

Corresponds to the JSON property onChange

Returns:



17264
17265
17266
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17264

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


17269
17270
17271
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17269

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


17274
17275
17276
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17274

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17281

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