class Comet::PublicBrandingProperties
PublicBrandingProperties
is a typed class wrapper around the underlying Comet
Server API data structure.
Attributes
account_register_url[RW]
@type [String] account_register_url
company_name[RW]
@type [String] company_name
default_login_server_url[RW]
@type [String] default_login_server_url
help_is_popup[RW]
@type [Boolean] help_is_popup
help_url[RW]
@type [String] help_url
hide_background_logo[RW]
@type [Boolean] hide_background_logo
product_name[RW]
@type [String] product_name
tile_background_color[RW]
@type [String] tile_background_color
unknown_json_fields[RW]
@type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
Public Class Methods
new()
click to toggle source
# File lib/comet/models/public_branding_properties.rb, line 44 def initialize clear end
Public Instance Methods
clear()
click to toggle source
# File lib/comet/models/public_branding_properties.rb, line 48 def clear @product_name = '' @company_name = '' @help_url = '' @default_login_server_url = '' @tile_background_color = '' @account_register_url = '' @unknown_json_fields = {} end
from_hash(obj)
click to toggle source
@param [Hash] obj The complete object as a Ruby hash
# File lib/comet/models/public_branding_properties.rb, line 66 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 '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 else @unknown_json_fields[k] = v end end end
from_json(json_string)
click to toggle source
@param [String] json_string The complete object in JSON format
# File lib/comet/models/public_branding_properties.rb, line 59 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()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/public_branding_properties.rb, line 123 def to_h to_hash end
to_hash()
click to toggle source
@return [Hash] The complete object as a Ruby hash
# File lib/comet/models/public_branding_properties.rb, line 106 def to_hash ret = {} 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 @unknown_json_fields.each do |k, v| ret[k] = v end ret end
to_json(options = {})
click to toggle source
@return [String] The complete object as a JSON string
# File lib/comet/models/public_branding_properties.rb, line 128 def to_json(options = {}) to_hash.to_json(options) end