class Comet::LiveUserConnection

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

def clear

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

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
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

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
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

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
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

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end