class Comet::ServerMetaBrandingProperties

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

def clear

def clear
  @brand_name = ''
  @product_name = ''
  @image_etag = ''
  @top_color = ''
  @accent_color = ''
  @prune_logs_after_days = 0
  @expired_in_seconds = 0
  @external_authentication_sources = []
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • 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 'BrandName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @brand_name = v
    when 'ProductName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @product_name = v
    when 'HasImage'
      @has_image = v
    when 'ImageEtag'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @image_etag = 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 'HideNewsArea'
      @hide_news_area = v
    when 'AllowUnauthenticatedDownloads'
      @allow_unauthenticated_downloads = v
    when 'AllowAuthenticatedDownloads'
      @allow_authenticated_downloads = v
    when 'PruneLogsAfterDays'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @prune_logs_after_days = v
    when 'ExpiredInSeconds'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @expired_in_seconds = v
    when 'ExternalAuthenticationSources'
      if v.nil?
        @external_authentication_sources = []
      else
        @external_authentication_sources = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @external_authentication_sources[i1] = Comet::ExternalAuthenticationSourceDisplay.new
          @external_authentication_sources[i1].from_hash(v1)
        end
      end
    else
      @unknown_json_fields[k] = v
    end
  end
end

def from_json(json_string)

Parameters:
  • 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

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_hash
  ret = {}
  ret['BrandName'] = @brand_name
  ret['ProductName'] = @product_name
  ret['HasImage'] = @has_image
  ret['ImageEtag'] = @image_etag
  ret['TopColor'] = @top_color
  ret['AccentColor'] = @accent_color
  ret['HideNewsArea'] = @hide_news_area
  ret['AllowUnauthenticatedDownloads'] = @allow_unauthenticated_downloads
  ret['AllowAuthenticatedDownloads'] = @allow_authenticated_downloads
  ret['PruneLogsAfterDays'] = @prune_logs_after_days
  ret['ExpiredInSeconds'] = @expired_in_seconds
  unless @external_authentication_sources.nil?
    ret['ExternalAuthenticationSources'] = @external_authentication_sources
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end