Class: Bandwidth::ParticipantSubscription

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb

Overview

ParticipantSubscription Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(participant_id = nil) ⇒ ParticipantSubscription

Returns a new instance of ParticipantSubscription.



33
34
35
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 33

def initialize(participant_id = nil)
  @participant_id = participant_id unless participant_id == SKIP
end

Instance Attribute Details

#participant_id ⇒ String

Participant the subscriber should be subscribed to

Returns:

  • (String) 


14
15
16
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 14

def participant_id
  @participant_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



38
39
40
41
42
43
44
45
46
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 38

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  participant_id = hash.key?('participantId') ? hash['participantId'] : SKIP

  # Create object from extracted values.
  ParticipantSubscription.new(participant_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['participant_id'] = 'participantId'
  @_hash
end

Instance Method Details

#nullables ⇒ Object

An array for nullable fields



29
30
31
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 29

def nullables
  []
end

#optionals ⇒ Object

An array for optional fields



24
25
26
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 24

def optionals
  []
end