Class: Comet::WebInterfaceBrandingProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/web_interface_branding_properties.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebInterfaceBrandingProperties

Returns a new instance of WebInterfaceBrandingProperties.



41
42
43
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 41

def initialize
  clear
end

Instance Attribute Details

#accent_color ⇒ Object

Returns the value of attribute accent_color.



30
31
32
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 30

def accent_color
  @accent_color
end

#brand_name ⇒ Object

Returns the value of attribute brand_name.



21
22
23
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 21

def brand_name
  @brand_name
end

#branding_style_type ⇒ Object

One of the BRANDINGSTYLETYPE_ constants This field is available in Comet 23.3.3 and later.



18
19
20
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 18

def branding_style_type
  @branding_style_type
end

#favicon ⇒ Object

Returns the value of attribute favicon.



33
34
35
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 33

def favicon
  @favicon
end

#hide_news_area ⇒ Object

Returns the value of attribute hide_news_area.



36
37
38
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 36

def hide_news_area
  @hide_news_area
end

#logo_image ⇒ Object

Returns the value of attribute logo_image.



24
25
26
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 24

def logo_image
  @logo_image
end

#top_color ⇒ Object

Returns the value of attribute top_color.



27
28
29
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 27

def top_color
  @top_color
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



39
40
41
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 39

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 45

def clear
  @branding_style_type = 0
  @brand_name = ''
  @logo_image = ''
  @top_color = ''
  @accent_color = ''
  @favicon = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 63

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
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


56
57
58
59
60
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 56

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 ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



117
118
119
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 117

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 101

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
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



122
123
124
 
# File 'lib/comet/models/web_interface_branding_properties.rb', line 122

def to_json(options = {})
  to_hash.to_json(options)
end