Class: ZoomUs::Models::AccountSettingsScheduleMeting

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

Overview

Account Settings: Schedule Meeting.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountSettingsScheduleMeting

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 130

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

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

  if attributes.has_key?(:'audio_type')
    self.audio_type = attributes[:'audio_type']
  else
    self.audio_type = 'both'
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#audio_type ⇒ Object

Determine how participants can join the audio portion of the meeting.
‘both` - Telephony and VoIP.
`telephony` - Audio PSTN telephony only.
`voip` - VoIP only.
`thirdParty` - 3rd party audio conference.



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

def audio_type
  @audio_type
end

#enforce_login ⇒ Object

Only Zoom users who are signed in can join meetings.



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

def 
  
end

#enforce_login_domains ⇒ Object

Only signed in users with a specified domain can join the meeting.



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

def 
  
end

#enforce_login_with_domains ⇒ Object

Only signed in users with a specific domain can join meetings.



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

def 
  
end

#force_pmi_jbh_password ⇒ Object

Require a password for Personal Meetings if attendees can join before host.



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

def force_pmi_jbh_password
  @force_pmi_jbh_password
end

#host_video ⇒ Object

Start meetings with the host video on.



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

def host_video
  @host_video
end

#join_before_host ⇒ Object

Allow participants to join the meeting before the host arrives.



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

def join_before_host
  @join_before_host
end

#not_store_meeting_topic ⇒ Object

Always display "Zoom Meeting" as the meeting topic.



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

def not_store_meeting_topic
  @not_store_meeting_topic
end

#participant_video ⇒ Object

Start meetings with the participant video on. Participants can change this setting during the meeting.



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

def participant_video
  @participant_video
end

#require_password_for_instant_meetings ⇒ Object

Require a password for instant meetings. If you use PMI for your instant meetings, this option will be disabled.



59
60
61
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 59

def require_password_for_instant_meetings
  @require_password_for_instant_meetings
end

#require_password_for_pmi_meetings ⇒ Object

Require a password for a meeting held using Personal Meeting ID (PMI)



62
63
64
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 62

def require_password_for_pmi_meetings
  @require_password_for_pmi_meetings
end

#require_password_for_scheduled_meetings ⇒ Object

Require a password for meetings which have already been scheduled



56
57
58
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 56

def require_password_for_scheduled_meetings
  @require_password_for_scheduled_meetings
end

#require_password_for_scheduling_new_meetings ⇒ Object

Require a password when scheduling new meetings. This setting applies for regular meetings that do not use PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting.



53
54
55
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 53

def require_password_for_scheduling_new_meetings
  @require_password_for_scheduling_new_meetings
end

#use_pmi_for_instant_meetings ⇒ Object

Use Personal Meeting ID (PMI) when starting an instant meeting



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

def use_pmi_for_instant_meetings
  @use_pmi_for_instant_meetings
end

#use_pmi_for_scheduled_meetings ⇒ Object

Use Personal Meeting ID (PMI) when scheduling a meeting



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

def use_pmi_for_scheduled_meetings
  @use_pmi_for_scheduled_meetings
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 87

def self.attribute_map
  {
    :'host_video' => :'host_video',
    :'participant_video' => :'participant_video',
    :'audio_type' => :'audio_type',
    :'join_before_host' => :'join_before_host',
    :'enforce_login' => :'enforce_login',
    :'enforce_login_with_domains' => :'enforce_login_with_domains',
    :'enforce_login_domains' => :'enforce_login_domains',
    :'not_store_meeting_topic' => :'not_store_meeting_topic',
    :'force_pmi_jbh_password' => :'force_pmi_jbh_password',
    :'use_pmi_for_scheduled_meetings' => :'use_pmi_for_scheduled_meetings',
    :'use_pmi_for_instant_meetings' => :'use_pmi_for_instant_meetings',
    :'require_password_for_scheduling_new_meetings' => :'require_password_for_scheduling_new_meetings',
    :'require_password_for_scheduled_meetings' => :'require_password_for_scheduled_meetings',
    :'require_password_for_instant_meetings' => :'require_password_for_instant_meetings',
    :'require_password_for_pmi_meetings' => :'require_password_for_pmi_meetings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 108

def self.swagger_types
  {
    :'host_video' => :'BOOLEAN',
    :'participant_video' => :'BOOLEAN',
    :'audio_type' => :'String',
    :'join_before_host' => :'BOOLEAN',
    :'enforce_login' => :'BOOLEAN',
    :'enforce_login_with_domains' => :'BOOLEAN',
    :'enforce_login_domains' => :'String',
    :'not_store_meeting_topic' => :'BOOLEAN',
    :'force_pmi_jbh_password' => :'BOOLEAN',
    :'use_pmi_for_scheduled_meetings' => :'BOOLEAN',
    :'use_pmi_for_instant_meetings' => :'BOOLEAN',
    :'require_password_for_scheduling_new_meetings' => :'BOOLEAN',
    :'require_password_for_scheduled_meetings' => :'BOOLEAN',
    :'require_password_for_instant_meetings' => :'BOOLEAN',
    :'require_password_for_pmi_meetings' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    host_video == o.host_video &&
    participant_video == o.participant_video &&
    audio_type == o.audio_type &&
    join_before_host == o.join_before_host &&
     == o. &&
     == o. &&
     == o. &&
    not_store_meeting_topic == o.not_store_meeting_topic &&
    force_pmi_jbh_password == o.force_pmi_jbh_password &&
    use_pmi_for_scheduled_meetings == o.use_pmi_for_scheduled_meetings &&
    use_pmi_for_instant_meetings == o.use_pmi_for_instant_meetings &&
    require_password_for_scheduling_new_meetings == o.require_password_for_scheduling_new_meetings &&
    require_password_for_scheduled_meetings == o.require_password_for_scheduled_meetings &&
    require_password_for_instant_meetings == o.require_password_for_instant_meetings &&
    require_password_for_pmi_meetings == o.require_password_for_pmi_meetings
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 294

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 360

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 273

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


260
261
262
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 266

def hash
  [host_video, participant_video, audio_type, join_before_host, , , , not_store_meeting_topic, force_pmi_jbh_password, use_pmi_for_scheduled_meetings, use_pmi_for_instant_meetings, require_password_for_scheduling_new_meetings, require_password_for_scheduled_meetings, require_password_for_instant_meetings, require_password_for_pmi_meetings].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



201
202
203
204
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 201

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



340
341
342
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 346

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



334
335
336
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 334

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



208
209
210
211
212
213
214
 
# File 'lib/zoom_us/models/account_settings_schedule_meting.rb', line 208

def valid?
  audio_type_validator = EnumAttributeValidator.new('String', ['both', 'telephony', 'voip', 'thirdParty'])
  return false unless audio_type_validator.valid?(@audio_type)
  require_password_for_pmi_meetings_validator = EnumAttributeValidator.new('String', ['jbh_only', 'all', 'none'])
  return false unless require_password_for_pmi_meetings_validator.valid?(@require_password_for_pmi_meetings)
  true
end