Class: ZoomUs::Models::Channel

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/models/channel.rb

Overview

The channel object represents a Zoom chat [channel](support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Channel

Initializes the object



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/zoom_us/models/channel.rb', line 48

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end
end

Instance Attribute Details

#id ⇒ Object

Channel Id.



20
21
22
 
# File 'lib/zoom_us/models/channel.rb', line 20

def id
  @id
end

#name ⇒ Object

Name of the channel.



23
24
25
 
# File 'lib/zoom_us/models/channel.rb', line 23

def name
  @name
end

#type ⇒ Object

Type of the channel. The value can be one of the following:
‘1`: Private channel. In this type of channel, members must be invited to join a channel.
`2`: Private channel with members that belong to one Zoom account. Members in this channel should be invited and the members should be from the same organization.
`3`: Public channel. Anyone can search for this channel and join the channel.



26
27
28
 
# File 'lib/zoom_us/models/channel.rb', line 26

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/zoom_us/models/channel.rb', line 29

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'type' => :'type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
 
# File 'lib/zoom_us/models/channel.rb', line 38

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'type' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



97
98
99
100
101
102
103
 
# File 'lib/zoom_us/models/channel.rb', line 97

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    id == o.id &&
    name == o.name &&
    type == o.type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



141
142
143
144
145
146
147
148
149
150
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
176
177
 
# File 'lib/zoom_us/models/channel.rb', line 141

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    ::DateTime.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
    temp_model = Models.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/zoom_us/models/channel.rb', line 207

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/zoom_us/models/channel.rb', line 120

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


107
108
109
 
# File 'lib/zoom_us/models/channel.rb', line 107

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



113
114
115
 
# File 'lib/zoom_us/models/channel.rb', line 113

def hash
  [id, name, type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



69
70
71
72
73
74
75
76
 
# File 'lib/zoom_us/models/channel.rb', line 69

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 128
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



187
188
189
 
# File 'lib/zoom_us/models/channel.rb', line 187

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
 
# File 'lib/zoom_us/models/channel.rb', line 193

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



181
182
183
 
# File 'lib/zoom_us/models/channel.rb', line 181

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



80
81
82
83
 
# File 'lib/zoom_us/models/channel.rb', line 80

def valid?
  return false if !@name.nil? && @name.to_s.length > 128
  true
end