Class: TelegramBot::ReplyParameters

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

Overview

Describes reply parameters for the message that is being sent.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReplyParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
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
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 79

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

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

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

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

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

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

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

Instance Attribute Details

#allow_sending_without_reply ⇒ Object

Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.



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

def allow_sending_without_reply
  @allow_sending_without_reply
end

#chat_id ⇒ Object

Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account.



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

def chat_id
  @chat_id
end

#message_id ⇒ Object

Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified



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

def message_id
  @message_id
end

#quote ⇒ Object

Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn’t found in the original message.



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

def quote
  @quote
end

#quote_entities ⇒ Object

Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode.



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

def quote_entities
  @quote_entities
end

#quote_parse_mode ⇒ Object

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



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

def quote_parse_mode
  @quote_parse_mode
end

#quote_position ⇒ Object

Optional. Position of the quote in the original message in UTF-16 code units



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

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



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
234
235
236
237
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 200

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



54
55
56
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 41

def self.attribute_map
  {
    :'message_id' => :'message_id',
    :'chat_id' => :'chat_id',
    :'allow_sending_without_reply' => :'allow_sending_without_reply',
    :'quote' => :'quote',
    :'quote_parse_mode' => :'quote_parse_mode',
    :'quote_entities' => :'quote_entities',
    :'quote_position' => :'quote_position'
  }
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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 176

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



72
73
74
75
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 59

def self.openapi_types
  {
    :'message_id' => :'Integer',
    :'chat_id' => :'Hash<String, SendMessageChatIdParameterValue>',
    :'allow_sending_without_reply' => :'Boolean',
    :'quote' => :'String',
    :'quote_parse_mode' => :'String',
    :'quote_entities' => :'Array<MessageEntity>',
    :'quote_position' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message_id == o.message_id &&
      chat_id == o.chat_id &&
      allow_sending_without_reply == o.allow_sending_without_reply &&
      quote == o.quote &&
      quote_parse_mode == o.quote_parse_mode &&
      quote_entities == o.quote_entities &&
      quote_position == o.quote_position
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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 271

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


163
164
165
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



169
170
171
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 169

def hash
  [message_id, chat_id, allow_sending_without_reply, quote, quote_parse_mode, quote_entities, quote_position].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



129
130
131
132
133
134
135
136
137
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 129

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @message_id.nil?
    invalid_properties.push('invalid value for "message_id", message_id 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



247
248
249
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 247

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



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

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



241
242
243
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 241

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



141
142
143
144
145
 
# File 'lib/telegram-bot/models/reply_parameters.rb', line 141

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