class Comet::BrandingOptions
BrandingOptions
is a typed class wrapper around the underlying Comet
Server API data structure.
Attributes
@type [String] account_register_url
@type [String] brand_name
@type [String] company_name
@type [String] default_login_server_url
@type [String] favicon
@type [Boolean] help_is_popup
@type [String] help_url
@type [Boolean] hide_background_logo
@type [Boolean] hide_news_area
@type [String] logo_image
@type [Comet::MacOSCodeSignProperties] mac_oscode_sign
@type [String] package_identifier
@type [String] path_eula_rtf
@type [String] path_header_image
@type [String] path_icns_file
@type [String] path_ico_file
@type [String] path_tile_png
@type [String] product_name
@type [String] tile_background_color
@type [String] top_color
@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
@type [String] windows_code_sign_pkcs11certfile
@type [String] windows_code_sign_pkcs11engine
@type [String] windows_code_sign_pkcs11key_id
@type [String] windows_code_sign_pkcs11module
@type [String] windows_code_sign_pkcs11password
@type [Number] windows_code_sign_pkcs11password_format
@type [String] windows_code_sign_pkcs12file_path
@type [String] windows_code_sign_pkcs12password
@type [Number] windows_code_sign_pkcs12password_format
Public Class Methods
# File lib/comet/models/branding_options.rb, line 110 def initialize clear end
Public Instance Methods
# File lib/comet/models/branding_options.rb, line 114 def clear @brand_name = '' @logo_image = '' @top_color = '' @favicon = '' @product_name = '' @company_name = '' @help_url = '' @default_login_server_url = '' @tile_background_color = '' @account_register_url = '' @path_ico_file = '' @path_icns_file = '' @path_menu_bar_icns_file = '' @path_eula_rtf = '' @path_tile_png = '' @path_header_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
@param [Hash] obj The complete object as a Ruby hash
# File lib/comet/models/branding_options.rb, line 153 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 '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 '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 '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 '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
@param [String] json_string The complete object in JSON format
# File lib/comet/models/branding_options.rb, line 146 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
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/branding_options.rb, line 317 def to_h to_hash end
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/branding_options.rb, line 278 def to_hash ret = {} ret['BrandName'] = @brand_name ret['LogoImage'] = @logo_image ret['TopColor'] = @top_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['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['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
@return [String] The complete object as a JSON string
# File lib/comet/models/branding_options.rb, line 322 def to_json(options = {}) to_hash.to_json(options) end