Class: Comet::DeviceConfig

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DeviceConfig

Returns a new instance of DeviceConfig.



42
43
44
 
# File 'lib/comet/models/device_config.rb', line 42

def initialize
  clear
end

Instance Attribute Details

#client_version ⇒ Object

This field is available in Comet 23.6.0 and later.



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

def client_version
  @client_version
end

#device_timezone ⇒ Object

The device’s reported timezone in IANA format.



33
34
35
 
# File 'lib/comet/models/device_config.rb', line 33

def device_timezone
  @device_timezone
end

#friendly_name ⇒ Object

Returns the value of attribute friendly_name.



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

def friendly_name
  @friendly_name
end

#platform_version ⇒ Object

The operating system that the device uses.



24
25
26
 
# File 'lib/comet/models/device_config.rb', line 24

def platform_version
  @platform_version
end

#registration_time ⇒ Object

Unix timestamp in seconds



20
21
22
 
# File 'lib/comet/models/device_config.rb', line 20

def registration_time
  @registration_time
end

#sources ⇒ Object

Minimal information about the device’s private Protected Items, so that other devices can safely run retention passes on a shared Storage Vault.



29
30
31
 
# File 'lib/comet/models/device_config.rb', line 29

def sources
  @sources
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



46
47
48
49
50
51
52
53
54
 
# File 'lib/comet/models/device_config.rb', line 46

def clear
  @friendly_name = ''
  @registration_time = 0
  @platform_version = Comet::OSInfo.new
  @sources = {}
  @device_timezone = ''
  @client_version = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/comet/models/device_config.rb', line 64

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

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

      @registration_time = v
    when 'PlatformVersion'
      @platform_version = Comet::OSInfo.new
      @platform_version.from_hash(v)
    when 'Sources'
      @sources = {}
      if v.nil?
        @sources = {}
      else
        v.each do |k1, v1|
          @sources[k1] = Comet::SourceBasicInfo.new
          @sources[k1].from_hash(v1)
        end
      end
    when 'DeviceTimezone'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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


57
58
59
60
61
 
# File 'lib/comet/models/device_config.rb', line 57

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



130
131
132
 
# File 'lib/comet/models/device_config.rb', line 130

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/comet/models/device_config.rb', line 105

def to_hash
  ret = {}
  ret['FriendlyName'] = @friendly_name
  unless @registration_time.nil?
    ret['RegistrationTime'] = @registration_time
  end
  unless @platform_version.nil?
    ret['PlatformVersion'] = @platform_version
  end
  unless @sources.nil?
    ret['Sources'] = @sources
  end
  unless @device_timezone.nil?
    ret['DeviceTimezone'] = @device_timezone
  end
  unless @client_version.nil?
    ret['ClientVersion'] = @client_version
  end
  @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



135
136
137
 
# File 'lib/comet/models/device_config.rb', line 135

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