Class: Comet::RegistrationLobbyConnection

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RegistrationLobbyConnection

Returns a new instance of RegistrationLobbyConnection.



48
49
50
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 48

def initialize
  clear
end

Instance Attribute Details

#connection_time ⇒ Object

Returns the value of attribute connection_time.



43
44
45
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 43

def connection_time
  @connection_time
end

#device_id ⇒ Object

Returns the value of attribute device_id.



16
17
18
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 16

def device_id
  @device_id
end

#device_time_zone ⇒ Object

Returns the value of attribute device_time_zone.



34
35
36
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 34

def device_time_zone
  @device_time_zone
end

#friendly_name ⇒ Object

Returns the value of attribute friendly_name.



22
23
24
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 22

def friendly_name
  @friendly_name
end

#host ⇒ Object

Returns the value of attribute host.



40
41
42
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 40

def host
  @host
end

#ipaddress ⇒ Object

Returns the value of attribute ipaddress.



37
38
39
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 37

def ipaddress
  @ipaddress
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



19
20
21
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 19

def organization_id
  @organization_id
end

#reported_platform ⇒ Object

Returns the value of attribute reported_platform.



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

def reported_platform
  @reported_platform
end

#reported_platform_version ⇒ Object

Returns the value of attribute reported_platform_version.



31
32
33
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 31

def reported_platform_version
  @reported_platform_version
end

#reported_version ⇒ Object

Returns the value of attribute reported_version.



25
26
27
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 25

def reported_version
  @reported_version
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



46
47
48
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 46

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 52

def clear
  @device_id = ''
  @organization_id = ''
  @friendly_name = ''
  @reported_version = ''
  @reported_platform = ''
  @reported_platform_version = Comet::OSInfo.new
  @device_time_zone = ''
  @ipaddress = ''
  @host = ''
  @connection_time = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 74

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 'DeviceID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @device_id = v
    when 'OrganizationID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @organization_id = v
    when 'FriendlyName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @friendly_name = v
    when 'ReportedVersion'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @reported_version = v
    when 'ReportedPlatform'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @reported_platform = v
    when 'ReportedPlatformVersion'
      @reported_platform_version = Comet::OSInfo.new
      @reported_platform_version.from_hash(v)
    when 'DeviceTimeZone'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @device_time_zone = v
    when 'IPAddress'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @ipaddress = v
    when 'Host'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @host = v
    when 'ConnectionTime'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @connection_time = 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) 


67
68
69
70
71
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 67

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



152
153
154
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 152

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 125

def to_hash
  ret = {}
  ret['DeviceID'] = @device_id
  ret['OrganizationID'] = @organization_id
  ret['FriendlyName'] = @friendly_name
  ret['ReportedVersion'] = @reported_version
  ret['ReportedPlatform'] = @reported_platform
  unless @reported_platform_version.nil?
    ret['ReportedPlatformVersion'] = @reported_platform_version
  end
  unless @device_time_zone.nil?
    ret['DeviceTimeZone'] = @device_time_zone
  end
  unless @ipaddress.nil?
    ret['IPAddress'] = @ipaddress
  end
  unless @host.nil?
    ret['Host'] = @host
  end
  ret['ConnectionTime'] = @connection_time
  @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



157
158
159
 
# File 'lib/comet/models/registration_lobby_connection.rb', line 157

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