class Comet::WebInterfaceBrandingProperties

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

Attributes

brand_name[RW]

@type [String] brand_name

favicon[RW]

@type [String] favicon

hide_news_area[RW]

@type [Boolean] hide_news_area

logo_image[RW]

@type [String] logo_image

top_color[RW]

@type [String] top_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/web_interface_branding_properties.rb, line 35
def initialize
  clear
end

Public Instance Methods

clear() click to toggle source
# File lib/comet/models/web_interface_branding_properties.rb, line 39
def clear
  @brand_name = ''
  @logo_image = ''
  @top_color = ''
  @favicon = ''
  @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/web_interface_branding_properties.rb, line 55
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
    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/web_interface_branding_properties.rb, line 48
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/web_interface_branding_properties.rb, line 99
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/web_interface_branding_properties.rb, line 85
def to_hash
  ret = {}
  ret['BrandName'] = @brand_name
  ret['LogoImage'] = @logo_image
  ret['TopColor'] = @top_color
  ret['Favicon'] = @favicon
  ret['HideNewsArea'] = @hide_news_area
  @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/web_interface_branding_properties.rb, line 104
def to_json(options = {})
  to_hash.to_json(options)
end