Class: TelegramBot::InlineQueryResultDocument

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

Overview

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineQueryResultDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 114

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TelegramBot::InlineQueryResultDocument` 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::InlineQueryResultDocument`. 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?(:'title')
    self.title = attributes[:'title']
  else
    self.title = nil
  end

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

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

  if attributes.key?(:'caption_entities')
    if (value = attributes[:'caption_entities']).is_a?(Array)
      self.caption_entities = value
    end
  end

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

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  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

#caption ⇒ Object

Optional. Caption of the document to be sent, 0-1024 characters after entities parsing



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

def caption
  @caption
end

#caption_entities ⇒ Object

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode



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

def caption_entities
  @caption_entities
end

#description ⇒ Object

Optional. Short description of the result



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

def description
  @description
end

#document_url ⇒ Object

A valid URL for the file



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

def document_url
  @document_url
end

#id ⇒ Object

Unique identifier for this result, 1-64 bytes



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

def id
  @id
end

#input_message_content ⇒ Object

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



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

def input_message_content
  @input_message_content
end

#mime_type ⇒ Object

MIME type of the content of the file, either "application/pdf" or "application/zip"



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

def mime_type
  @mime_type
end

#parse_mode ⇒ Object

Optional. Mode for parsing entities in the document caption. See formatting options for more details.



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

def parse_mode
  @parse_mode
end

#reply_markup ⇒ Object

Optional. Inline keyboard attached to the message



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

def reply_markup
  @reply_markup
end

#thumbnail_height ⇒ Object

Optional. Thumbnail height



59
60
61
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 59

def thumbnail_height
  @thumbnail_height
end

#thumbnail_url ⇒ Object

Optional. URL of the thumbnail (JPEG only) for the file



53
54
55
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 53

def thumbnail_url
  @thumbnail_url
end

#thumbnail_width ⇒ Object

Optional. Thumbnail width



56
57
58
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 56

def thumbnail_width
  @thumbnail_width
end

#title ⇒ Object

Title for the result



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

def title
  @title
end

#type ⇒ Object

Type of the result, must be document



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

def type
  @type
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 296

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



82
83
84
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 62

def self.attribute_map
  {
    :'type' => :'type',
    :'id' => :'id',
    :'title' => :'title',
    :'caption' => :'caption',
    :'parse_mode' => :'parse_mode',
    :'caption_entities' => :'caption_entities',
    :'document_url' => :'document_url',
    :'mime_type' => :'mime_type',
    :'description' => :'description',
    :'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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 272

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



107
108
109
110
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 87

def self.openapi_types
  {
    :'type' => :'String',
    :'id' => :'String',
    :'title' => :'String',
    :'caption' => :'String',
    :'parse_mode' => :'String',
    :'caption_entities' => :'Array<MessageEntity>',
    :'document_url' => :'String',
    :'mime_type' => :'String',
    :'description' => :'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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      id == o.id &&
      title == o.title &&
      caption == o.caption &&
      parse_mode == o.parse_mode &&
      caption_entities == o.caption_entities &&
      document_url == o.document_url &&
      mime_type == o.mime_type &&
      description == o.description &&
      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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 367

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


259
260
261
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 265

def hash
  [type, id, title, caption, parse_mode, caption_entities, document_url, mime_type, description, 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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 198

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 @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

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

  if @mime_type.nil?
    invalid_properties.push('invalid value for "mime_type", mime_type 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



343
344
345
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 343

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 349

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



337
338
339
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 337

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



226
227
228
229
230
231
232
233
234
 
# File 'lib/telegram-bot/models/inline_query_result_document.rb', line 226

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