Class: Comet::PrivateBrandingProperties

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PrivateBrandingProperties

Returns a new instance of PrivateBrandingProperties.



74
75
76
 
# File 'lib/comet/models/private_branding_properties.rb', line 74

def initialize
  clear
end

Instance Attribute Details

#mac_oscode_sign ⇒ Object

Returns the value of attribute mac_oscode_sign.



69
70
71
 
# File 'lib/comet/models/private_branding_properties.rb', line 69

def mac_oscode_sign
  @mac_oscode_sign
end

#package_identifier ⇒ Object

Returns the value of attribute package_identifier.



39
40
41
 
# File 'lib/comet/models/private_branding_properties.rb', line 39

def package_identifier
  @package_identifier
end

#path_app_icon_image ⇒ Object

Returns the value of attribute path_app_icon_image.



36
37
38
 
# File 'lib/comet/models/private_branding_properties.rb', line 36

def path_app_icon_image
  @path_app_icon_image
end

#path_eula_rtf ⇒ Object

Returns the value of attribute path_eula_rtf.



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

def path_eula_rtf
  @path_eula_rtf
end

#path_header_image ⇒ Object

Returns the value of attribute path_header_image.



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

def path_header_image
  @path_header_image
end

#path_icns_file ⇒ Object

Returns the value of attribute path_icns_file.



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

def path_icns_file
  @path_icns_file
end

#path_ico_file ⇒ Object

Returns the value of attribute path_ico_file.



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

def path_ico_file
  @path_ico_file
end

#path_menu_bar_icns_file ⇒ Object

Returns the value of attribute path_menu_bar_icns_file.



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

def path_menu_bar_icns_file
  @path_menu_bar_icns_file
end

#path_tile_png ⇒ Object

Returns the value of attribute path_tile_png.



30
31
32
 
# File 'lib/comet/models/private_branding_properties.rb', line 30

def path_tile_png
  @path_tile_png
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



72
73
74
 
# File 'lib/comet/models/private_branding_properties.rb', line 72

def unknown_json_fields
  @unknown_json_fields
end

#windows_code_sign_pkcs11certfile ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11certfile.



57
58
59
 
# File 'lib/comet/models/private_branding_properties.rb', line 57

def windows_code_sign_pkcs11certfile
  @windows_code_sign_pkcs11certfile
end

#windows_code_sign_pkcs11engine ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11engine.



51
52
53
 
# File 'lib/comet/models/private_branding_properties.rb', line 51

def windows_code_sign_pkcs11engine
  @windows_code_sign_pkcs11engine
end

#windows_code_sign_pkcs11key_id ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11key_id.



60
61
62
 
# File 'lib/comet/models/private_branding_properties.rb', line 60

def windows_code_sign_pkcs11key_id
  @windows_code_sign_pkcs11key_id
end

#windows_code_sign_pkcs11module ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11module.



54
55
56
 
# File 'lib/comet/models/private_branding_properties.rb', line 54

def windows_code_sign_pkcs11module
  @windows_code_sign_pkcs11module
end

#windows_code_sign_pkcs11password ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11password.



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

def windows_code_sign_pkcs11password
  @windows_code_sign_pkcs11password
end

#windows_code_sign_pkcs11password_format ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11password_format.



63
64
65
 
# File 'lib/comet/models/private_branding_properties.rb', line 63

def windows_code_sign_pkcs11password_format
  @windows_code_sign_pkcs11password_format
end

#windows_code_sign_pkcs12file_path ⇒ Object

Returns the value of attribute windows_code_sign_pkcs12file_path.



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

def windows_code_sign_pkcs12file_path
  @windows_code_sign_pkcs12file_path
end

#windows_code_sign_pkcs12password ⇒ Object

Returns the value of attribute windows_code_sign_pkcs12password.



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

def windows_code_sign_pkcs12password
  @windows_code_sign_pkcs12password
end

#windows_code_sign_pkcs12password_format ⇒ Object

Returns the value of attribute windows_code_sign_pkcs12password_format.



45
46
47
 
# File 'lib/comet/models/private_branding_properties.rb', line 45

def windows_code_sign_pkcs12password_format
  @windows_code_sign_pkcs12password_format
end

Instance Method Details

#clear ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/comet/models/private_branding_properties.rb', line 78

def clear
  @path_ico_file = ''
  @path_icns_file = ''
  @path_menu_bar_icns_file = ''
  @path_eula_rtf = ''
  @path_tile_png = ''
  @path_header_image = ''
  @path_app_icon_image = ''
  @package_identifier = ''
  @windows_code_sign_pkcs12file_path = ''
  @windows_code_sign_pkcs12password_format = 0
  @windows_code_sign_pkcs12password = ''
  @windows_code_sign_pkcs11engine = ''
  @windows_code_sign_pkcs11module = ''
  @windows_code_sign_pkcs11certfile = ''
  @windows_code_sign_pkcs11key_id = ''
  @windows_code_sign_pkcs11password_format = 0
  @windows_code_sign_pkcs11password = ''
  @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/comet/models/private_branding_properties.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      @windows_code_sign_pkcs11password = v
    when 'MacOSCodeSign'
      @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
      @mac_oscode_sign.from_hash(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) 


101
102
103
104
105
 
# File 'lib/comet/models/private_branding_properties.rb', line 101

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



218
219
220
 
# File 'lib/comet/models/private_branding_properties.rb', line 218

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/comet/models/private_branding_properties.rb', line 191

def to_hash
  ret = {}
  ret['PathIcoFile'] = @path_ico_file
  ret['PathIcnsFile'] = @path_icns_file
  ret['PathMenuBarIcnsFile'] = @path_menu_bar_icns_file
  ret['PathEulaRtf'] = @path_eula_rtf
  ret['PathTilePng'] = @path_tile_png
  ret['PathHeaderImage'] = @path_header_image
  ret['PathAppIconImage'] = @path_app_icon_image
  ret['PackageIdentifier'] = @package_identifier
  ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
  ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format
  ret['WindowsCodeSignPKCS12Password'] = @windows_code_sign_pkcs12password
  ret['WindowsCodeSignPKCS11Engine'] = @windows_code_sign_pkcs11engine
  ret['WindowsCodeSignPKCS11Module'] = @windows_code_sign_pkcs11module
  ret['WindowsCodeSignPKCS11Certfile'] = @windows_code_sign_pkcs11certfile
  ret['WindowsCodeSignPKCS11KeyID'] = @windows_code_sign_pkcs11key_id
  ret['WindowsCodeSignPKCS11PasswordFormat'] = @windows_code_sign_pkcs11password_format
  ret['WindowsCodeSignPKCS11Password'] = @windows_code_sign_pkcs11password
  ret['MacOSCodeSign'] = @mac_oscode_sign
  @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



223
224
225
 
# File 'lib/comet/models/private_branding_properties.rb', line 223

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