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.



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

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

Instance Attribute Details

#participant_idString

Participant the subscriber should be subscribed to

Returns:

  • (String)


11
12
13
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 11

def participant_id
  @participant_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



25
26
27
28
29
30
31
32
33
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb', line 25

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  participant_id = hash['participantId']

  # Create object from extracted values.

  ParticipantSubscription.new(participant_id)
end

.namesObject

A mapping from model property names to API property names.



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

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