Class: Comet::BrandingOptions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BrandingOptions

Returns a new instance of BrandingOptions.



149
150
151
 
# File 'lib/comet/models/branding_options.rb', line 149

def initialize
  clear
end

Instance Attribute Details

#accent_color ⇒ Object

Returns the value of attribute accent_color.



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

def accent_color
  @accent_color
end

#account_register_url ⇒ Object

Returns the value of attribute account_register_url.



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

def 
  @account_register_url
end

#brand_name ⇒ Object

Returns the value of attribute brand_name.



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

def brand_name
  @brand_name
end

#branding_style_type ⇒ Object

One of the BRANDINGSTYLETYPE_ constants This field is available in Comet 23.3.3 and later.



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

def branding_style_type
  @branding_style_type
end

#build_mode ⇒ Object

One of the CLIENTBRANDINGBUILD_ constants



64
65
66
 
# File 'lib/comet/models/branding_options.rb', line 64

def build_mode
  @build_mode
end

#company_name ⇒ Object

Returns the value of attribute company_name.



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

def company_name
  @company_name
end

#default_login_server_url ⇒ Object

Returns the value of attribute default_login_server_url.



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

def 
  @default_login_server_url
end

#favicon ⇒ Object

Returns the value of attribute favicon.



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

def favicon
  @favicon
end

#help_is_popup ⇒ Object

Returns the value of attribute help_is_popup.



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

def help_is_popup
  @help_is_popup
end

#help_url ⇒ Object

Returns the value of attribute help_url.



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

def help_url
  @help_url
end

#hide_background_logo ⇒ Object

Returns the value of attribute hide_background_logo.



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

def 
  @hide_background_logo
end

#hide_news_area ⇒ Object

Returns the value of attribute hide_news_area.



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

def hide_news_area
  @hide_news_area
end

#logo_image ⇒ Object

Returns the value of attribute logo_image.



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

def logo_image
  @logo_image
end

#mac_oscode_sign ⇒ Object

Returns the value of attribute mac_oscode_sign.



144
145
146
 
# File 'lib/comet/models/branding_options.rb', line 144

def mac_oscode_sign
  @mac_oscode_sign
end

#package_identifier ⇒ Object

Returns the value of attribute package_identifier.



88
89
90
 
# File 'lib/comet/models/branding_options.rb', line 88

def package_identifier
  @package_identifier
end

#path_app_icon_image ⇒ Object

Returns the value of attribute path_app_icon_image.



85
86
87
 
# File 'lib/comet/models/branding_options.rb', line 85

def path_app_icon_image
  @path_app_icon_image
end

#path_eula_rtf ⇒ Object

Returns the value of attribute path_eula_rtf.



76
77
78
 
# File 'lib/comet/models/branding_options.rb', line 76

def path_eula_rtf
  @path_eula_rtf
end

#path_header_image ⇒ Object

Returns the value of attribute path_header_image.



82
83
84
 
# File 'lib/comet/models/branding_options.rb', line 82

def path_header_image
  @path_header_image
end

#path_icns_file ⇒ Object

Returns the value of attribute path_icns_file.



70
71
72
 
# File 'lib/comet/models/branding_options.rb', line 70

def path_icns_file
  @path_icns_file
end

#path_ico_file ⇒ Object

Returns the value of attribute path_ico_file.



67
68
69
 
# File 'lib/comet/models/branding_options.rb', line 67

def path_ico_file
  @path_ico_file
end

#path_menu_bar_icns_file ⇒ Object

Returns the value of attribute path_menu_bar_icns_file.



73
74
75
 
# File 'lib/comet/models/branding_options.rb', line 73

def path_menu_bar_icns_file
  @path_menu_bar_icns_file
end

#path_tile_png ⇒ Object

Returns the value of attribute path_tile_png.



79
80
81
 
# File 'lib/comet/models/branding_options.rb', line 79

def path_tile_png
  @path_tile_png
end

#product_name ⇒ Object

Returns the value of attribute product_name.



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

def product_name
  @product_name
end

#tile_background_color ⇒ Object

Returns the value of attribute tile_background_color.



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

def tile_background_color
  @tile_background_color
end

#top_color ⇒ Object

Returns the value of attribute top_color.



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

def top_color
  @top_color
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



147
148
149
 
# File 'lib/comet/models/branding_options.rb', line 147

def unknown_json_fields
  @unknown_json_fields
end

#windows_code_sign_azure_app_id ⇒ Object

Returns the value of attribute windows_code_sign_azure_app_id.



131
132
133
 
# File 'lib/comet/models/branding_options.rb', line 131

def windows_code_sign_azure_app_id
  @windows_code_sign_azure_app_id
end

#windows_code_sign_azure_app_secret ⇒ Object

Returns the value of attribute windows_code_sign_azure_app_secret.



138
139
140
 
# File 'lib/comet/models/branding_options.rb', line 138

def windows_code_sign_azure_app_secret
  @windows_code_sign_azure_app_secret
end

#windows_code_sign_azure_app_secret_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



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

def windows_code_sign_azure_app_secret_format
  @windows_code_sign_azure_app_secret_format
end

#windows_code_sign_azure_cert_name ⇒ Object

Returns the value of attribute windows_code_sign_azure_cert_name.



128
129
130
 
# File 'lib/comet/models/branding_options.rb', line 128

def windows_code_sign_azure_cert_name
  @windows_code_sign_azure_cert_name
end

#windows_code_sign_azure_tenant_id ⇒ Object

Returns the value of attribute windows_code_sign_azure_tenant_id.



141
142
143
 
# File 'lib/comet/models/branding_options.rb', line 141

def windows_code_sign_azure_tenant_id
  @windows_code_sign_azure_tenant_id
end

#windows_code_sign_azure_vault_name ⇒ Object

Returns the value of attribute windows_code_sign_azure_vault_name.



125
126
127
 
# File 'lib/comet/models/branding_options.rb', line 125

def windows_code_sign_azure_vault_name
  @windows_code_sign_azure_vault_name
end

#windows_code_sign_method ⇒ Object

One of the WINDOWSCODESIGN_METHOD_ constants



92
93
94
 
# File 'lib/comet/models/branding_options.rb', line 92

def windows_code_sign_method
  @windows_code_sign_method
end

#windows_code_sign_pkcs11certfile ⇒ Object

This field was deprecated between 23.3.0 and 23.6.x, but is now used again.



112
113
114
 
# File 'lib/comet/models/branding_options.rb', line 112

def windows_code_sign_pkcs11certfile
  @windows_code_sign_pkcs11certfile
end

#windows_code_sign_pkcs11engine ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11engine.



105
106
107
 
# File 'lib/comet/models/branding_options.rb', line 105

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.



115
116
117
 
# File 'lib/comet/models/branding_options.rb', line 115

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.



108
109
110
 
# File 'lib/comet/models/branding_options.rb', line 108

def windows_code_sign_pkcs11module
  @windows_code_sign_pkcs11module
end

#windows_code_sign_pkcs11password ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11password.



122
123
124
 
# File 'lib/comet/models/branding_options.rb', line 122

def windows_code_sign_pkcs11password
  @windows_code_sign_pkcs11password
end

#windows_code_sign_pkcs11password_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



119
120
121
 
# File 'lib/comet/models/branding_options.rb', line 119

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.



95
96
97
 
# File 'lib/comet/models/branding_options.rb', line 95

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.



102
103
104
 
# File 'lib/comet/models/branding_options.rb', line 102

def windows_code_sign_pkcs12password
  @windows_code_sign_pkcs12password
end

#windows_code_sign_pkcs12password_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



99
100
101
 
# File 'lib/comet/models/branding_options.rb', line 99

def windows_code_sign_pkcs12password_format
  @windows_code_sign_pkcs12password_format
end

Instance Method Details

#clear ⇒ Object 



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
189
190
191
192
193
 
# File 'lib/comet/models/branding_options.rb', line 153

def clear
  @branding_style_type = 0
  @brand_name = ''
  @logo_image = ''
  @top_color = ''
  @accent_color = ''
  @favicon = ''
  @product_name = ''
  @company_name = ''
  @help_url = ''
  @default_login_server_url = ''
  @tile_background_color = ''
  @account_register_url = ''
  @build_mode = 0
  @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_method = 0
  @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 = ''
  @windows_code_sign_azure_vault_name = ''
  @windows_code_sign_azure_cert_name = ''
  @windows_code_sign_azure_app_id = ''
  @windows_code_sign_azure_app_secret_format = 0
  @windows_code_sign_azure_app_secret = ''
  @windows_code_sign_azure_tenant_id = ''
  @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) 


203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/comet/models/branding_options.rb', line 203

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

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

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

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

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

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

      @favicon = v
    when 'HideNewsArea'
      @hide_news_area = v
    when 'ProductName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

      @help_url = v
    when 'HelpIsPopup'
      @help_is_popup = v
    when 'DefaultLoginServerURL'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

      @account_register_url = v
    when 'HideBackgroundLogo'
      @hide_background_logo = v
    when 'BuildMode'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @build_mode = v
    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 'WindowsCodeSignMethod'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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

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

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

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

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

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

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


196
197
198
199
200
 
# File 'lib/comet/models/branding_options.rb', line 196

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



422
423
424
 
# File 'lib/comet/models/branding_options.rb', line 422

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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/comet/models/branding_options.rb', line 372

def to_hash
  ret = {}
  ret['BrandingStyleType'] = @branding_style_type
  ret['BrandName'] = @brand_name
  ret['LogoImage'] = @logo_image
  ret['TopColor'] = @top_color
  ret['AccentColor'] = @accent_color
  ret['Favicon'] = @favicon
  ret['HideNewsArea'] = @hide_news_area
  ret['ProductName'] = @product_name
  ret['CompanyName'] = @company_name
  ret['HelpURL'] = @help_url
  ret['HelpIsPopup'] = @help_is_popup
  ret['DefaultLoginServerURL'] = @default_login_server_url
  ret['TileBackgroundColor'] = @tile_background_color
  ret['AccountRegisterURL'] = @account_register_url
  ret['HideBackgroundLogo'] = @hide_background_logo
  ret['BuildMode'] = @build_mode
  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['WindowsCodeSignMethod'] = @windows_code_sign_method
  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['WindowsCodeSignAzureVaultName'] = @windows_code_sign_azure_vault_name
  ret['WindowsCodeSignAzureCertName'] = @windows_code_sign_azure_cert_name
  ret['WindowsCodeSignAzureAppID'] = @windows_code_sign_azure_app_id
  ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
  ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
  ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
  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



427
428
429
 
# File 'lib/comet/models/branding_options.rb', line 427

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