Class: Comet::SessionOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/session_options.rb

Overview

SessionOptions is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SessionOptions

Returns a new instance of SessionOptions.



23
24
25
 
# File 'lib/comet/models/session_options.rb', line 23

def initialize
  clear
end

Instance Attribute Details

#expired_in_seconds ⇒ Object

The number of seconds, after which an administrator should be automatically logged out of the Comet Server web interface. If zero, will be replaced with DEFAULT_SESSIONTIMEOUT.



18
19
20
 
# File 'lib/comet/models/session_options.rb', line 18

def expired_in_seconds
  @expired_in_seconds
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



21
22
23
 
# File 'lib/comet/models/session_options.rb', line 21

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



27
28
29
30
 
# File 'lib/comet/models/session_options.rb', line 27

def clear
  @expired_in_seconds = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/comet/models/session_options.rb', line 40

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'ExpiredInSeconds'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @expired_in_seconds = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


33
34
35
36
37
 
# File 'lib/comet/models/session_options.rb', line 33

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



66
67
68
 
# File 'lib/comet/models/session_options.rb', line 66

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



56
57
58
59
60
61
62
63
 
# File 'lib/comet/models/session_options.rb', line 56

def to_hash
  ret = {}
  ret['ExpiredInSeconds'] = @expired_in_seconds
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



71
72
73
 
# File 'lib/comet/models/session_options.rb', line 71

def to_json(options = {})
  to_hash.to_json(options)
end