Class: TelegramBot::ChatInviteLink

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

Overview

Represents an invite link for a chat.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatInviteLink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 89

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#creates_join_request ⇒ Object

True, if users joining the chat via the link need to be approved by chat administrators



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

def creates_join_request
  @creates_join_request
end

#creator ⇒ Object

Creator of the link



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

def creator
  @creator
end

#expire_date ⇒ Object

Optional. Point in time (Unix timestamp) when the link will expire or has been expired



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

def expire_date
  @expire_date
end

#invite_link ⇒ Object

The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with "…".



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

def invite_link
  @invite_link
end

#is_primary ⇒ Object

True, if the link is primary



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

def is_primary
  @is_primary
end

#is_revoked ⇒ Object

True, if the link is revoked



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

def is_revoked
  @is_revoked
end

#member_limit ⇒ Object

Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999



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

def member_limit
  @member_limit
end

#name ⇒ Object

Optional. Invite link name



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

def name
  @name
end

#pending_join_request_count ⇒ Object

Optional. Number of pending join requests created using this link



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

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



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

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



62
63
64
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 47

def self.attribute_map
  {
    :'invite_link' => :'invite_link',
    :'creator' => :'creator',
    :'creates_join_request' => :'creates_join_request',
    :'is_primary' => :'is_primary',
    :'is_revoked' => :'is_revoked',
    :'name' => :'name',
    :'expire_date' => :'expire_date',
    :'member_limit' => :'member_limit',
    :'pending_join_request_count' => :'pending_join_request_count'
  }
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



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

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



82
83
84
85
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 67

def self.openapi_types
  {
    :'invite_link' => :'String',
    :'creator' => :'User',
    :'creates_join_request' => :'Boolean',
    :'is_primary' => :'Boolean',
    :'is_revoked' => :'Boolean',
    :'name' => :'String',
    :'expire_date' => :'Integer',
    :'member_limit' => :'Integer',
    :'pending_join_request_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      invite_link == o.invite_link &&
      creator == o.creator &&
      creates_join_request == o.creates_join_request &&
      is_primary == o.is_primary &&
      is_revoked == o.is_revoked &&
      name == o.name &&
      expire_date == o.expire_date &&
      member_limit == o.member_limit &&
      pending_join_request_count == o.pending_join_request_count
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



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

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


207
208
209
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 213

def hash
  [invite_link, creator, creates_join_request, is_primary, is_revoked, name, expire_date, member_limit, pending_join_request_count].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



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

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

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

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

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

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



291
292
293
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 291

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



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

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



285
286
287
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 285

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
185
186
187
 
# File 'lib/telegram-bot/models/chat_invite_link.rb', line 179

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @invite_link.nil?
  return false if @creator.nil?
  return false if @creates_join_request.nil?
  return false if @is_primary.nil?
  return false if @is_revoked.nil?
  true
end