Class: TelegramBot::Sticker

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

Overview

This object represents a sticker.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Sticker

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/telegram-bot/models/sticker.rb', line 119

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#custom_emoji_id ⇒ Object

Optional. For custom emoji stickers, unique identifier of the custom emoji



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

def custom_emoji_id
  @custom_emoji_id
end

#emoji ⇒ Object

Optional. Emoji associated with the sticker



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

def emoji
  @emoji
end

#file_id ⇒ Object

Identifier for this file, which can be used to download or reuse the file



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

def file_id
  @file_id
end

#file_size ⇒ Object

Optional. File size in bytes



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

def file_size
  @file_size
end

#file_unique_id ⇒ Object

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.



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

def file_unique_id
  @file_unique_id
end

#height ⇒ Object

Sticker height



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

def height
  @height
end

#is_animated ⇒ Object

True, if the sticker is animated



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

def is_animated
  @is_animated
end

#is_video ⇒ Object

True, if the sticker is a video sticker



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

def is_video
  @is_video
end

#mask_position ⇒ Object

Optional. For mask stickers, the position where the mask should be placed



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

def mask_position
  @mask_position
end

#needs_repainting ⇒ Object

Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places



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

def needs_repainting
  @needs_repainting
end

#premium_animation ⇒ Object

Optional. For premium regular stickers, premium animation for the sticker



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

def premium_animation
  @premium_animation
end

#set_name ⇒ Object

Optional. Name of the sticker set to which the sticker belongs



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

def set_name
  @set_name
end

#thumbnail ⇒ Object

Optional. Sticker thumbnail in the .WEBP or .JPG format



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

def thumbnail
  @thumbnail
end

#type ⇒ Object

Type of the sticker, currently one of "regular", "mask", "custom_emoji". The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.



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

def type
  @type
end

#width ⇒ Object

Sticker width



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

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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/telegram-bot/models/sticker.rb', line 318

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



86
87
88
 
# File 'lib/telegram-bot/models/sticker.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/telegram-bot/models/sticker.rb', line 65

def self.attribute_map
  {
    :'file_id' => :'file_id',
    :'file_unique_id' => :'file_unique_id',
    :'type' => :'type',
    :'width' => :'width',
    :'height' => :'height',
    :'is_animated' => :'is_animated',
    :'is_video' => :'is_video',
    :'thumbnail' => :'thumbnail',
    :'emoji' => :'emoji',
    :'set_name' => :'set_name',
    :'premium_animation' => :'premium_animation',
    :'mask_position' => :'mask_position',
    :'custom_emoji_id' => :'custom_emoji_id',
    :'needs_repainting' => :'needs_repainting',
    :'file_size' => :'file_size'
  }
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/telegram-bot/models/sticker.rb', line 294

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



112
113
114
115
 
# File 'lib/telegram-bot/models/sticker.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/telegram-bot/models/sticker.rb', line 91

def self.openapi_types
  {
    :'file_id' => :'String',
    :'file_unique_id' => :'String',
    :'type' => :'String',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'is_animated' => :'Boolean',
    :'is_video' => :'Boolean',
    :'thumbnail' => :'PhotoSize',
    :'emoji' => :'String',
    :'set_name' => :'String',
    :'premium_animation' => :'File',
    :'mask_position' => :'MaskPosition',
    :'custom_emoji_id' => :'String',
    :'needs_repainting' => :'Boolean',
    :'file_size' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/telegram-bot/models/sticker.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_id == o.file_id &&
      file_unique_id == o.file_unique_id &&
      type == o.type &&
      width == o.width &&
      height == o.height &&
      is_animated == o.is_animated &&
      is_video == o.is_video &&
      thumbnail == o.thumbnail &&
      emoji == o.emoji &&
      set_name == o.set_name &&
      premium_animation == o.premium_animation &&
      mask_position == o.mask_position &&
      custom_emoji_id == o.custom_emoji_id &&
      needs_repainting == o.needs_repainting &&
      file_size == o.file_size
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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/telegram-bot/models/sticker.rb', line 389

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


281
282
283
 
# File 'lib/telegram-bot/models/sticker.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



287
288
289
 
# File 'lib/telegram-bot/models/sticker.rb', line 287

def hash
  [file_id, file_unique_id, type, width, height, is_animated, is_video, thumbnail, emoji, set_name, premium_animation, mask_position, custom_emoji_id, needs_repainting, file_size].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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/telegram-bot/models/sticker.rb', line 209

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

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

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

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

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

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

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



365
366
367
 
# File 'lib/telegram-bot/models/sticker.rb', line 365

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/telegram-bot/models/sticker.rb', line 371

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



359
360
361
 
# File 'lib/telegram-bot/models/sticker.rb', line 359

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



245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/telegram-bot/models/sticker.rb', line 245

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @file_id.nil?
  return false if @file_unique_id.nil?
  return false if @type.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @is_animated.nil?
  return false if @is_video.nil?
  true
end