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.



19231
19232
19233
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19231

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:



19181
19182
19183
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19181

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:



19188
19189
19190
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19188

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) 


19193
19194
19195
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19193

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


19199
19200
19201
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19199

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) 


19204
19205
19206
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19204

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


19209
19210
19211
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19209

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) 


19214
19215
19216
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19214

def name
  @name
end

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

Corresponds to the JSON property onChange

Returns:



19219
19220
19221
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19219

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


19224
19225
19226
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19224

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


19229
19230
19231
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19229

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19236
19237
19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19236

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