Class: TelegramBot::InputMediaAudio

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

Overview

Represents an audio file to be treated as music to be sent.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InputMediaAudio

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
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
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 89

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

  if attributes.key?(:'thumbnail')
    if (value = attributes[:'thumbnail']).is_a?(Hash)
      self.thumbnail = value
    end
  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?(:'duration')
    self.duration = attributes[:'duration']
  end

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

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

Instance Attribute Details

#caption ⇒ Object

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



29
30
31
 
# File 'lib/telegram-bot/models/input_media_audio.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/input_media_audio.rb', line 35

def caption_entities
  @caption_entities
end

#duration ⇒ Object

Optional. Duration of the audio in seconds



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

def duration
  @duration
end

#media ⇒ Object

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: core.telegram.org/bots/api#sending-files



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

def media
  @media
end

#parse_mode ⇒ Object

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



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

def parse_mode
  @parse_mode
end

#performer ⇒ Object

Optional. Performer of the audio



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

def performer
  @performer
end

#thumbnail ⇒ Object

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: core.telegram.org/bots/api#sending-files



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

def thumbnail
  @thumbnail
end

#title ⇒ Object

Optional. Title of the audio



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

def title
  @title
end

#type ⇒ Object

Type of the result, must be audio



20
21
22
 
# File 'lib/telegram-bot/models/input_media_audio.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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 227

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



62
63
64
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 47

def self.attribute_map
  {
    :'type' => :'type',
    :'media' => :'media',
    :'thumbnail' => :'thumbnail',
    :'caption' => :'caption',
    :'parse_mode' => :'parse_mode',
    :'caption_entities' => :'caption_entities',
    :'duration' => :'duration',
    :'performer' => :'performer',
    :'title' => :'title'
  }
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



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 67

def self.openapi_types
  {
    :'type' => :'String',
    :'media' => :'String',
    :'thumbnail' => :'Hash<String, SendPhotoPhotoParameterValue>',
    :'caption' => :'String',
    :'parse_mode' => :'String',
    :'caption_entities' => :'Array<MessageEntity>',
    :'duration' => :'Integer',
    :'performer' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      media == o.media &&
      thumbnail == o.thumbnail &&
      caption == o.caption &&
      parse_mode == o.parse_mode &&
      caption_entities == o.caption_entities &&
      duration == o.duration &&
      performer == o.performer &&
      title == o.title
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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 298

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


190
191
192
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



196
197
198
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 196

def hash
  [type, media, thumbnail, caption, parse_mode, caption_entities, duration, performer, title].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



149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 149

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



274
275
276
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 274

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 280

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



268
269
270
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 268

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



165
166
167
168
169
170
 
# File 'lib/telegram-bot/models/input_media_audio.rb', line 165

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