Class: TelegramBot::KeyboardButtonRequestChat

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

Overview

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats: core.telegram.org/bots/features#chat-and-user-selection.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KeyboardButtonRequestChat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 99

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bot_administrator_rights ⇒ Object

Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.



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

def bot_administrator_rights
  @bot_administrator_rights
end

#bot_is_member ⇒ Object

Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.



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

def bot_is_member
  @bot_is_member
end

#chat_has_username ⇒ Object

Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.



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

def chat_has_username
  @chat_has_username
end

#chat_is_channel ⇒ Object

Pass True to request a channel chat, pass False to request a group or a supergroup chat.



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

def chat_is_channel
  @chat_is_channel
end

#chat_is_created ⇒ Object

Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.



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

def chat_is_created
  @chat_is_created
end

#chat_is_forum ⇒ Object

Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.



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

def chat_is_forum
  @chat_is_forum
end

#request_id ⇒ Object

Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message



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

def request_id
  @request_id
end

#request_photo ⇒ Object

Optional. Pass True to request the chat’s photo



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

def request_photo
  @request_photo
end

#request_title ⇒ Object

Optional. Pass True to request the chat’s title



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

def request_title
  @request_title
end

#request_username ⇒ Object

Optional. Pass True to request the chat’s username



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

def request_username
  @request_username
end

#user_administrator_rights ⇒ Object

Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.



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

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 243

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



70
71
72
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 53

def self.attribute_map
  {
    :'request_id' => :'request_id',
    :'chat_is_channel' => :'chat_is_channel',
    :'chat_is_forum' => :'chat_is_forum',
    :'chat_has_username' => :'chat_has_username',
    :'chat_is_created' => :'chat_is_created',
    :'user_administrator_rights' => :'user_administrator_rights',
    :'bot_administrator_rights' => :'bot_administrator_rights',
    :'bot_is_member' => :'bot_is_member',
    :'request_title' => :'request_title',
    :'request_username' => :'request_username',
    :'request_photo' => :'request_photo'
  }
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 219

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



92
93
94
95
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 75

def self.openapi_types
  {
    :'request_id' => :'Integer',
    :'chat_is_channel' => :'Boolean',
    :'chat_is_forum' => :'Boolean',
    :'chat_has_username' => :'Boolean',
    :'chat_is_created' => :'Boolean',
    :'user_administrator_rights' => :'ChatAdministratorRights',
    :'bot_administrator_rights' => :'ChatAdministratorRights',
    :'bot_is_member' => :'Boolean',
    :'request_title' => :'Boolean',
    :'request_username' => :'Boolean',
    :'request_photo' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_id == o.request_id &&
      chat_is_channel == o.chat_is_channel &&
      chat_is_forum == o.chat_is_forum &&
      chat_has_username == o.chat_has_username &&
      chat_is_created == o.chat_is_created &&
      user_administrator_rights == o.user_administrator_rights &&
      bot_administrator_rights == o.bot_administrator_rights &&
      bot_is_member == o.bot_is_member &&
      request_title == o.request_title &&
      request_username == o.request_username &&
      request_photo == o.request_photo
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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 314

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


206
207
208
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 212

def hash
  [request_id, chat_is_channel, chat_is_forum, chat_has_username, chat_is_created, user_administrator_rights, bot_administrator_rights, bot_is_member, request_title, request_username, request_photo].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



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 163

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

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



290
291
292
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 290

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



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

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



284
285
286
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 284

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



179
180
181
182
183
184
 
# File 'lib/telegram-bot/models/keyboard_button_request_chat.rb', line 179

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