Class: Bandwidth::Session

Inherits:
BaseModel show all
Defined in:
lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb

Overview

A session object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id = nil, tag = nil) ⇒ Session

Returns a new instance of Session.



25
26
27
28
29
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 25

def initialize(id = nil,
               tag = nil)
  @id = id
  @tag = tag
end

Instance Attribute Details

#id ⇒ String

Unique id of the session

Returns:

  • (String) 


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

def id
  @id
end

#tag ⇒ String

User defined tag to associate with the session

Returns:

  • (String) 


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

def tag
  @tag
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 32

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash['id']
  tag = hash['tag']

  # Create object from extracted values.
  Session.new(id,
              tag)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
23
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 18

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