Class: TelegramBot::InlineQueryResultContact

Inherits:
Object
  • Object
show all
Defined in:
lib/telegram-bot/models/inline_query_result_contact.rb

Overview

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineQueryResultContact

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TelegramBot::InlineQueryResultContact` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TelegramBot::InlineQueryResultContact`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'phone_number')
    self.phone_number = attributes[:'phone_number']
  else
    self.phone_number = nil
  end

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  else
    self.first_name = nil
  end

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.key?(:'vcard')
    self.vcard = attributes[:'vcard']
  end

  if attributes.key?(:'reply_markup')
    self.reply_markup = attributes[:'reply_markup']
  end

  if attributes.key?(:'input_message_content')
    self.input_message_content = attributes[:'input_message_content']
  end

  if attributes.key?(:'thumbnail_url')
    self.thumbnail_url = attributes[:'thumbnail_url']
  end

  if attributes.key?(:'thumbnail_width')
    self.thumbnail_width = attributes[:'thumbnail_width']
  end

  if attributes.key?(:'thumbnail_height')
    self.thumbnail_height = attributes[:'thumbnail_height']
  end
end

Instance Attribute Details

#first_name ⇒ Object

Contact’s first name



29
30
31
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 29

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier for this result, 1-64 Bytes



23
24
25
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 23

def id
  @id
end

#input_message_content ⇒ Object

Optional. Content of the message to be sent instead of the contact



41
42
43
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 41

def input_message_content
  @input_message_content
end

#last_name ⇒ Object

Optional. Contact’s last name



32
33
34
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 32

def last_name
  @last_name
end

#phone_number ⇒ Object

Contact’s phone number



26
27
28
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 26

def phone_number
  @phone_number
end

#reply_markup ⇒ Object

Optional. Inline keyboard attached to the message



38
39
40
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 38

def reply_markup
  @reply_markup
end

#thumbnail_height ⇒ Object

Optional. Thumbnail height



50
51
52
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 50

def thumbnail_height
  @thumbnail_height
end

#thumbnail_url ⇒ Object

Optional. Url of the thumbnail for the result



44
45
46
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 44

def thumbnail_url
  @thumbnail_url
end

#thumbnail_width ⇒ Object

Optional. Thumbnail width



47
48
49
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 47

def thumbnail_width
  @thumbnail_width
end

#type ⇒ Object

Type of the result, must be contact



20
21
22
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 20

def type
  @type
end

#vcard ⇒ Object

Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes



35
36
37
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 35

def vcard
  @vcard
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 257

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = TelegramBot.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 53

def self.attribute_map
  {
    :'type' => :'type',
    :'id' => :'id',
    :'phone_number' => :'phone_number',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'vcard' => :'vcard',
    :'reply_markup' => :'reply_markup',
    :'input_message_content' => :'input_message_content',
    :'thumbnail_url' => :'thumbnail_url',
    :'thumbnail_width' => :'thumbnail_width',
    :'thumbnail_height' => :'thumbnail_height'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 233

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 92

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 75

def self.openapi_types
  {
    :'type' => :'String',
    :'id' => :'String',
    :'phone_number' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'vcard' => :'String',
    :'reply_markup' => :'InlineKeyboardMarkup',
    :'input_message_content' => :'Object',
    :'thumbnail_url' => :'String',
    :'thumbnail_width' => :'Integer',
    :'thumbnail_height' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      id == o.id &&
      phone_number == o.phone_number &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      vcard == o.vcard &&
      reply_markup == o.reply_markup &&
      input_message_content == o.input_message_content &&
      thumbnail_url == o.thumbnail_url &&
      thumbnail_width == o.thumbnail_width &&
      thumbnail_height == o.thumbnail_height
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 328

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 226

def hash
  [type, id, phone_number, first_name, last_name, vcard, reply_markup, input_message_content, thumbnail_url, thumbnail_width, thumbnail_height].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 167

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @phone_number.nil?
    invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
  end

  if @first_name.nil?
    invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 304

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 310

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



298
299
300
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 298

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



191
192
193
194
195
196
197
198
 
# File 'lib/telegram-bot/models/inline_query_result_contact.rb', line 191

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @id.nil?
  return false if @phone_number.nil?
  return false if @first_name.nil?
  true
end