Class: TelegramBot::ReplyKeyboardMarkup

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

Overview

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReplyKeyboardMarkup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
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
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 74

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

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

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

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

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

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

Instance Attribute Details

#input_field_placeholder ⇒ Object

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters



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

def input_field_placeholder
  @input_field_placeholder
end

#is_persistent ⇒ Object

Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.



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

def is_persistent
  @is_persistent
end

#keyboard ⇒ Object

Array of button rows, each represented by an Array of KeyboardButton objects



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

def keyboard
  @keyboard
end

#one_time_keyboard ⇒ Object

Optional. Requests clients to hide the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.



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

def one_time_keyboard
  @one_time_keyboard
end

#resize_keyboard ⇒ Object

Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app’s standard keyboard.



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

def resize_keyboard
  @resize_keyboard
end

#selective ⇒ Object

Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot’s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.



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

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



188
189
190
191
192
193
194
195
196
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
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 188

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 38

def self.attribute_map
  {
    :'keyboard' => :'keyboard',
    :'is_persistent' => :'is_persistent',
    :'resize_keyboard' => :'resize_keyboard',
    :'one_time_keyboard' => :'one_time_keyboard',
    :'input_field_placeholder' => :'input_field_placeholder',
    :'selective' => :'selective'
  }
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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 164

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



67
68
69
70
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 55

def self.openapi_types
  {
    :'keyboard' => :'Array<Array<KeyboardButton>>',
    :'is_persistent' => :'Boolean',
    :'resize_keyboard' => :'Boolean',
    :'one_time_keyboard' => :'Boolean',
    :'input_field_placeholder' => :'String',
    :'selective' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      keyboard == o.keyboard &&
      is_persistent == o.is_persistent &&
      resize_keyboard == o.resize_keyboard &&
      one_time_keyboard == o.one_time_keyboard &&
      input_field_placeholder == o.input_field_placeholder &&
      selective == o.selective
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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 259

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


151
152
153
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



157
158
159
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 157

def hash
  [keyboard, is_persistent, resize_keyboard, one_time_keyboard, input_field_placeholder, selective].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



118
119
120
121
122
123
124
125
126
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 118

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



235
236
237
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 235

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 241

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



229
230
231
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 229

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



130
131
132
133
134
 
# File 'lib/telegram-bot/models/reply_keyboard_markup.rb', line 130

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