Class: TelegramBot::InlineKeyboardButton

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

Overview

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineKeyboardButton

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
147
148
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 94

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#callback_data ⇒ Object

Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes



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

def callback_data
  @callback_data
end

#callback_game ⇒ Object

Optional. Description of the game that will be launched when the user presses the button. NOTE: This type of button must always be the first button in the first row.



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

def callback_game
  @callback_game
end

#login_url ⇒ Object

Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.



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

def 
  @login_url
end

#pay ⇒ Object

Optional. Specify True, to send a Pay button. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.



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

def pay
  @pay
end

#switch_inline_query ⇒ Object

Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot’s username and the specified inline query in the input field. May be empty, in which case just the bot’s username will be inserted.



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

def switch_inline_query
  @switch_inline_query
end

#switch_inline_query_chosen_chat ⇒ Object

Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot’s username and the specified inline query in the input field



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

def switch_inline_query_chosen_chat
  @switch_inline_query_chosen_chat
end

#switch_inline_query_current_chat ⇒ Object

Optional. If set, pressing the button will insert the bot’s username and the specified inline query in the current chat’s input field. May be empty, in which case only the bot’s username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.



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

def switch_inline_query_current_chat
  @switch_inline_query_current_chat
end

#text ⇒ Object

Label text on the button



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

def text
  @text
end

#url ⇒ Object

Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.



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

def url
  @url
end

#web_app ⇒ Object

Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.



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

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



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

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



66
67
68
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 50

def self.attribute_map
  {
    :'text' => :'text',
    :'url' => :'url',
    :'callback_data' => :'callback_data',
    :'web_app' => :'web_app',
    :'login_url' => :'login_url',
    :'switch_inline_query' => :'switch_inline_query',
    :'switch_inline_query_current_chat' => :'switch_inline_query_current_chat',
    :'switch_inline_query_chosen_chat' => :'switch_inline_query_chosen_chat',
    :'callback_game' => :'callback_game',
    :'pay' => :'pay'
  }
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



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

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



87
88
89
90
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 71

def self.openapi_types
  {
    :'text' => :'String',
    :'url' => :'String',
    :'callback_data' => :'String',
    :'web_app' => :'WebAppInfo',
    :'login_url' => :'LoginUrl',
    :'switch_inline_query' => :'String',
    :'switch_inline_query_current_chat' => :'String',
    :'switch_inline_query_chosen_chat' => :'SwitchInlineQueryChosenChat',
    :'callback_game' => :'Object',
    :'pay' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      text == o.text &&
      url == o.url &&
      callback_data == o.callback_data &&
      web_app == o.web_app &&
       == o. &&
      switch_inline_query == o.switch_inline_query &&
      switch_inline_query_current_chat == o.switch_inline_query_current_chat &&
      switch_inline_query_chosen_chat == o.switch_inline_query_chosen_chat &&
      callback_game == o.callback_game &&
      pay == o.pay
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



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

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


189
190
191
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 195

def hash
  [text, url, callback_data, web_app, , switch_inline_query, switch_inline_query_current_chat, switch_inline_query_chosen_chat, callback_game, pay].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



152
153
154
155
156
157
158
159
160
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 152

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



273
274
275
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 273

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



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

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



267
268
269
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 267

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



164
165
166
167
168
 
# File 'lib/telegram-bot/models/inline_keyboard_button.rb', line 164

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