Class: ZoomUs::Models::WebinarInfo

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

Overview

Webinar object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebinarInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
155
156
157
 
# File 'lib/zoom_us/models/webinar_info.rb', line 96

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?(:'topic')
    self.topic = attributes[:'topic']
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'tracking_fields')
    if (value = attributes[:'tracking_fields']).is_a?(Array)
      self.tracking_fields = value
    end
  end

  if attributes.has_key?(:'occurrences')
    if (value = attributes[:'occurrences']).is_a?(Array)
      self.occurrences = value
    end
  end

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

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

Instance Attribute Details

#agenda ⇒ Object

Webinar agenda.



35
36
37
 
# File 'lib/zoom_us/models/webinar_info.rb', line 35

def agenda
  @agenda
end

#created_at ⇒ Object

Create time.



38
39
40
 
# File 'lib/zoom_us/models/webinar_info.rb', line 38

def created_at
  @created_at
end

#duration ⇒ Object

Webinar duration.



29
30
31
 
# File 'lib/zoom_us/models/webinar_info.rb', line 29

def duration
  @duration
end

#join_url ⇒ Object

Join URL.



44
45
46
 
# File 'lib/zoom_us/models/webinar_info.rb', line 44

def join_url
  @join_url
end

#occurrences ⇒ Object

Array of occurrence objects.



50
51
52
 
# File 'lib/zoom_us/models/webinar_info.rb', line 50

def occurrences
  @occurrences
end

#recurrence ⇒ Object

Returns the value of attribute recurrence.



54
55
56
 
# File 'lib/zoom_us/models/webinar_info.rb', line 54

def recurrence
  @recurrence
end

#settings ⇒ Object

Returns the value of attribute settings.



52
53
54
 
# File 'lib/zoom_us/models/webinar_info.rb', line 52

def settings
  @settings
end

#start_time ⇒ Object

Webinar start time.



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

def start_time
  @start_time
end

#start_url ⇒ Object


<aside>The start_url of a Webinar is a URL using which a host or an alternative host can start the Webinar. The expiration time for the start_url field listed in the response of [Create a Webinar API](marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate) is two hours for all regular users. For users created using the custCreate option via the [Create Users](marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API, the expiration time of the start_url field is 90 days. For security reasons, to retrieve the latest value for the start_url field programmatically (after expiry), you must call the [Retrieve a Webinar API](marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinar) and refer to the value of the start_url field in the response.</aside>



41
42
43
 
# File 'lib/zoom_us/models/webinar_info.rb', line 41

def start_url
  @start_url
end

#timezone ⇒ Object

Time zone to format start_time.



32
33
34
 
# File 'lib/zoom_us/models/webinar_info.rb', line 32

def timezone
  @timezone
end

#topic ⇒ Object

Webinar topic.



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

def topic
  @topic
end

#tracking_fields ⇒ Object

Tracking fields



47
48
49
 
# File 'lib/zoom_us/models/webinar_info.rb', line 47

def tracking_fields
  @tracking_fields
end

#type ⇒ Object

Webinar Types:
‘5` - Webinar.
`6` - Recurring webinar with no fixed time.
`9` - Recurring webinar with a fixed time.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zoom_us/models/webinar_info.rb', line 57

def self.attribute_map
  {
    :'topic' => :'topic',
    :'type' => :'type',
    :'start_time' => :'start_time',
    :'duration' => :'duration',
    :'timezone' => :'timezone',
    :'agenda' => :'agenda',
    :'created_at' => :'created_at',
    :'start_url' => :'start_url',
    :'join_url' => :'join_url',
    :'tracking_fields' => :'tracking_fields',
    :'occurrences' => :'occurrences',
    :'settings' => :'settings',
    :'recurrence' => :'recurrence'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/zoom_us/models/webinar_info.rb', line 76

def self.swagger_types
  {
    :'topic' => :'String',
    :'type' => :'Integer',
    :'start_time' => :'DateTime',
    :'duration' => :'Integer',
    :'timezone' => :'String',
    :'agenda' => :'String',
    :'created_at' => :'DateTime',
    :'start_url' => :'String',
    :'join_url' => :'String',
    :'tracking_fields' => :'Array<UsersuserIdmeetingsTrackingFields>',
    :'occurrences' => :'Array<InlineResponse20110Occurrences>',
    :'settings' => :'InlineResponse20118Settings',
    :'recurrence' => :'RecurrenceWebinar'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/zoom_us/models/webinar_info.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    topic == o.topic &&
    type == o.type &&
    start_time == o.start_time &&
    duration == o.duration &&
    timezone == o.timezone &&
    agenda == o.agenda &&
    created_at == o.created_at &&
    start_url == o.start_url &&
    join_url == o.join_url &&
    tracking_fields == o.tracking_fields &&
    occurrences == o.occurrences &&
    settings == o.settings &&
    recurrence == o.recurrence
end

#_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



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
264
 
# File 'lib/zoom_us/models/webinar_info.rb', line 228

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/zoom_us/models/webinar_info.rb', line 294

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



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

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/zoom_us/models/webinar_info.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/zoom_us/models/webinar_info.rb', line 200

def hash
  [topic, type, start_time, duration, timezone, agenda, created_at, start_url, join_url, tracking_fields, occurrences, settings, recurrence].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



161
162
163
164
 
# File 'lib/zoom_us/models/webinar_info.rb', line 161

def list_invalid_properties
  invalid_properties = Array.new
  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



274
275
276
 
# File 'lib/zoom_us/models/webinar_info.rb', line 274

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



280
281
282
283
284
285
286
287
288
 
# File 'lib/zoom_us/models/webinar_info.rb', line 280

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

Returns:

  • (String) —

    String presentation of the object



268
269
270
 
# File 'lib/zoom_us/models/webinar_info.rb', line 268

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



168
169
170
 
# File 'lib/zoom_us/models/webinar_info.rb', line 168

def valid?
  true
end