class Comet::LiveUserConnection
LiveUserConnection
is a typed class wrapper around the underlying Comet
Server API data structure.
Attributes
allows_filenames[RW]
@type [Boolean] allows_filenames
connection_time[RW]
@type [Number] connection_time
device_id[RW]
@type [String] device_id
device_time_zone[RW]
@type [String] device_time_zone
ipaddress[RW]
@type [String] ipaddress
reported_platform[RW]
@type [String] reported_platform
reported_platform_version[RW]
@type [Comet::OSInfo] reported_platform_version
reported_version[RW]
@type [String] reported_version
unknown_json_fields[RW]
@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
username[RW]
@type [String] username
Public Class Methods
new()
click to toggle source
# File lib/comet/models/live_user_connection.rb, line 47 def initialize clear end
Public Instance Methods
clear()
click to toggle source
# File lib/comet/models/live_user_connection.rb, line 51 def clear @username = '' @device_id = '' @reported_version = '' @reported_platform = '' @reported_platform_version = Comet::OSInfo.new @device_time_zone = '' @ipaddress = '' @connection_time = 0 @unknown_json_fields = {} end
from_hash(obj)
click to toggle source
@param [Hash] obj The complete object as a Ruby hash
# File lib/comet/models/live_user_connection.rb, line 71 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 'Username' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @username = v when 'DeviceID' raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String @device_id = 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 'ConnectionTime' raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric @connection_time = v when 'AllowsFilenames' @allows_filenames = v else @unknown_json_fields[k] = v end end end
from_json(json_string)
click to toggle source
@param [String] json_string The complete object in JSON format
# File lib/comet/models/live_user_connection.rb, line 64 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()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/live_user_connection.rb, line 140 def to_h to_hash end
to_hash()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/live_user_connection.rb, line 116 def to_hash ret = {} ret['Username'] = @username ret['DeviceID'] = @device_id 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 ret['ConnectionTime'] = @connection_time ret['AllowsFilenames'] = @allows_filenames @unknown_json_fields.each do |k, v| ret[k] = v end ret end
to_json(options = {})
click to toggle source
@return [String] The complete object as a JSON string
# File lib/comet/models/live_user_connection.rb, line 145 def to_json(options = {}) to_hash.to_json(options) end