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.



19873
19874
19875
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19873

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:



19823
19824
19825
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19823

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:



19830
19831
19832
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19830

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) 


19835
19836
19837
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19835

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


19841
19842
19843
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19841

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) 


19846
19847
19848
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19846

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


19851
19852
19853
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19851

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) 


19856
19857
19858
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19856

def name
  @name
end

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

Corresponds to the JSON property onChange

Returns:



19861
19862
19863
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19861

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


19866
19867
19868
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19866

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


19871
19872
19873
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19871

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19878

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