Class: TelegramBot::Poll

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

Overview

This object contains information about a poll.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Poll

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/telegram-bot/models/poll.rb', line 109

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allows_multiple_answers ⇒ Object

True, if the poll allows multiple answers



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

def allows_multiple_answers
  @allows_multiple_answers
end

#close_date ⇒ Object

Optional. Point in time (Unix timestamp) when the poll will be automatically closed



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

def close_date
  @close_date
end

#correct_option_id ⇒ Object

Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.



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

def correct_option_id
  @correct_option_id
end

#explanation ⇒ Object

Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters



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

def explanation
  @explanation
end

#explanation_entities ⇒ Object

Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation



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

def explanation_entities
  @explanation_entities
end

#id ⇒ Object

Unique poll identifier



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

def id
  @id
end

#is_anonymous ⇒ Object

True, if the poll is anonymous



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

def is_anonymous
  @is_anonymous
end

#is_closed ⇒ Object

True, if the poll is closed



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

def is_closed
  @is_closed
end

#open_period ⇒ Object

Optional. Amount of time in seconds the poll will be active after creation



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

def open_period
  @open_period
end

#options ⇒ Object

List of poll options



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

def options
  @options
end

#question ⇒ Object

Poll question, 1-300 characters



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

def question
  @question
end

#total_voter_count ⇒ Object

Total number of users that voted in the poll



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

def total_voter_count
  @total_voter_count
end

#type ⇒ Object

Poll type, currently can be "regular" or "quiz"



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

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



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
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/telegram-bot/models/poll.rb', line 309

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



78
79
80
 
# File 'lib/telegram-bot/models/poll.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/telegram-bot/models/poll.rb', line 59

def self.attribute_map
  {
    :'id' => :'id',
    :'question' => :'question',
    :'options' => :'options',
    :'total_voter_count' => :'total_voter_count',
    :'is_closed' => :'is_closed',
    :'is_anonymous' => :'is_anonymous',
    :'type' => :'type',
    :'allows_multiple_answers' => :'allows_multiple_answers',
    :'correct_option_id' => :'correct_option_id',
    :'explanation' => :'explanation',
    :'explanation_entities' => :'explanation_entities',
    :'open_period' => :'open_period',
    :'close_date' => :'close_date'
  }
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/telegram-bot/models/poll.rb', line 285

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



102
103
104
105
 
# File 'lib/telegram-bot/models/poll.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/telegram-bot/models/poll.rb', line 83

def self.openapi_types
  {
    :'id' => :'String',
    :'question' => :'String',
    :'options' => :'Array<PollOption>',
    :'total_voter_count' => :'Integer',
    :'is_closed' => :'Boolean',
    :'is_anonymous' => :'Boolean',
    :'type' => :'String',
    :'allows_multiple_answers' => :'Boolean',
    :'correct_option_id' => :'Integer',
    :'explanation' => :'String',
    :'explanation_entities' => :'Array<MessageEntity>',
    :'open_period' => :'Integer',
    :'close_date' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/telegram-bot/models/poll.rb', line 252

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      question == o.question &&
      options == o.options &&
      total_voter_count == o.total_voter_count &&
      is_closed == o.is_closed &&
      is_anonymous == o.is_anonymous &&
      type == o.type &&
      allows_multiple_answers == o.allows_multiple_answers &&
      correct_option_id == o.correct_option_id &&
      explanation == o.explanation &&
      explanation_entities == o.explanation_entities &&
      open_period == o.open_period &&
      close_date == o.close_date
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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/telegram-bot/models/poll.rb', line 380

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


272
273
274
 
# File 'lib/telegram-bot/models/poll.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/telegram-bot/models/poll.rb', line 278

def hash
  [id, question, options, total_voter_count, is_closed, is_anonymous, type, allows_multiple_answers, correct_option_id, explanation, explanation_entities, open_period, close_date].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



197
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
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/telegram-bot/models/poll.rb', line 197

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

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

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

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

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

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

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

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



356
357
358
 
# File 'lib/telegram-bot/models/poll.rb', line 356

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/telegram-bot/models/poll.rb', line 362

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



350
351
352
 
# File 'lib/telegram-bot/models/poll.rb', line 350

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



237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/telegram-bot/models/poll.rb', line 237

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @question.nil?
  return false if @options.nil?
  return false if @total_voter_count.nil?
  return false if @is_closed.nil?
  return false if @is_anonymous.nil?
  return false if @type.nil?
  return false if @allows_multiple_answers.nil?
  true
end