Class: Comet::PublicBrandingProperties

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PublicBrandingProperties

Returns a new instance of PublicBrandingProperties.



42
43
44
 
# File 'lib/comet/models/public_branding_properties.rb', line 42

def initialize
  clear
end

Instance Attribute Details

#account_register_url ⇒ Object

Returns the value of attribute account_register_url.



34
35
36
 
# File 'lib/comet/models/public_branding_properties.rb', line 34

def 
  @account_register_url
end

#company_name ⇒ Object

Returns the value of attribute company_name.



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

def company_name
  @company_name
end

#default_login_server_url ⇒ Object

Returns the value of attribute default_login_server_url.



28
29
30
 
# File 'lib/comet/models/public_branding_properties.rb', line 28

def 
  @default_login_server_url
end

#help_is_popup ⇒ Object

Returns the value of attribute help_is_popup.



25
26
27
 
# File 'lib/comet/models/public_branding_properties.rb', line 25

def help_is_popup
  @help_is_popup
end

#help_url ⇒ Object

Returns the value of attribute help_url.



22
23
24
 
# File 'lib/comet/models/public_branding_properties.rb', line 22

def help_url
  @help_url
end

#hide_background_logo ⇒ Object

Returns the value of attribute hide_background_logo.



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

def 
  @hide_background_logo
end

#product_name ⇒ Object

Returns the value of attribute product_name.



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

def product_name
  @product_name
end

#tile_background_color ⇒ Object

Returns the value of attribute tile_background_color.



31
32
33
 
# File 'lib/comet/models/public_branding_properties.rb', line 31

def tile_background_color
  @tile_background_color
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

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) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
99
100
101
 
# File 'lib/comet/models/public_branding_properties.rb', line 64

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) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


57
58
59
60
61
 
# File 'lib/comet/models/public_branding_properties.rb', line 57

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



121
122
123
 
# File 'lib/comet/models/public_branding_properties.rb', line 121

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/comet/models/public_branding_properties.rb', line 104

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 = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



126
127
128
 
# File 'lib/comet/models/public_branding_properties.rb', line 126

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