Class: Comet::ServerMetaBrandingProperties

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ServerMetaBrandingProperties

Returns a new instance of ServerMetaBrandingProperties.



60
61
62
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 60

def initialize
  clear
end

Instance Attribute Details

#accent_color ⇒ Object

Colour in RGB hex format (e.g. “#FFFFFF”)



37
38
39
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 37

def accent_color
  @accent_color
end

#allow_authenticated_downloads ⇒ Object

Returns the value of attribute allow_authenticated_downloads.



46
47
48
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 46

def allow_authenticated_downloads
  @allow_authenticated_downloads
end

#allow_unauthenticated_downloads ⇒ Object

Returns the value of attribute allow_unauthenticated_downloads.



43
44
45
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 43

def allow_unauthenticated_downloads
  @allow_unauthenticated_downloads
end

#brand_name ⇒ Object

Returns the value of attribute brand_name.



16
17
18
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 16

def brand_name
  @brand_name
end

#expired_in_seconds ⇒ Object

Returns the value of attribute expired_in_seconds.



52
53
54
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 52

def expired_in_seconds
  @expired_in_seconds
end

#external_authentication_sources ⇒ Object

Returns the value of attribute external_authentication_sources.



55
56
57
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 55

def external_authentication_sources
  @external_authentication_sources
end

#has_image ⇒ Object

If true, this Comet Server has an image configured for its main logo. You can access it from the /gen/logo.img endpoint. If false, this Comet Server has text configured for its main logo.



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

def has_image
  @has_image
end

#hide_news_area ⇒ Object

Returns the value of attribute hide_news_area.



40
41
42
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 40

def hide_news_area
  @hide_news_area
end

#image_etag ⇒ Object

A value that will change if the branding image (/gen/logo.img) changes. You can use this as a cache key.



29
30
31
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 29

def image_etag
  @image_etag
end

#product_name ⇒ Object

Returns the value of attribute product_name.



19
20
21
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 19

def product_name
  @product_name
end

#prune_logs_after_days ⇒ Object

Returns the value of attribute prune_logs_after_days.



49
50
51
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 49

def prune_logs_after_days
  @prune_logs_after_days
end

#top_color ⇒ Object

Colour in RGB hex format (e.g. “#FFFFFF”)



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

def top_color
  @top_color
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



58
59
60
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 58

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 64

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

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 84

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

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


77
78
79
80
81
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 77

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



165
166
167
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 165

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 142

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

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



170
171
172
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 170

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