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.



41
42
43
44
45
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 41

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

Instance Attribute Details

#id ⇒ String

Unique id of the session

Returns:

  • (String) 


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

def id
  @id
end

#tag ⇒ String

User defined tag to associate with the session

Returns:

  • (String) 


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

def tag
  @tag
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 48

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  id = hash.key?('id') ? hash['id'] : SKIP
  tag = hash.key?('tag') ? hash['tag'] : SKIP

  # Create object from extracted values.

  Session.new(id,
              tag)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 21

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

Instance Method Details

#nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 37

def nullables
  []
end

#optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb', line 29

def optionals
  %w[
    id
    tag
  ]
end