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.



19145
19146
19147
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19145

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:



19095
19096
19097
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19095

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:



19102
19103
19104
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19102

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) 


19107
19108
19109
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19107

def auto_complete_multiple_selections
  @auto_complete_multiple_selections
end

#hint_text ⇒ String

Corresponds to the JSON property hintText

Returns:

  • (String) 


19113
19114
19115
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19113

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) 


19118
19119
19120
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19118

def label
  @label
end

#max_lines ⇒ Fixnum

Corresponds to the JSON property maxLines

Returns:

  • (Fixnum) 


19123
19124
19125
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19123

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) 


19128
19129
19130
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19128

def name
  @name
end

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

Corresponds to the JSON property onChange

Returns:



19133
19134
19135
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19133

def on_change
  @on_change
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


19138
19139
19140
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19138

def type
  @type
end

#value ⇒ String

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

Returns:

  • (String) 


19143
19144
19145
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19143

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 19150

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