class Comet::BrandingOptions
BrandingOptions is a typed class wrapper around the underlying Comet Server API data structure.
def clear
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
def from_hash(obj)
-
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 '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
def from_json(json_string)
-
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
-
(Hash)
- The complete object as a Ruby hash
def to_h to_hash end
def to_hash
-
(Hash)
- The complete object as a Ruby hash
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
def to_json(options = {})
-
(String)
- The complete object as a JSON string
def to_json(options = {}) to_hash.to_json(options) end