Class: Comet::AdminUserPermissions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AdminUserPermissions

Returns a new instance of AdminUserPermissions.



35
36
37
 
# File 'lib/comet/models/admin_user_permissions.rb', line 35

def initialize
  clear
end

Instance Attribute Details

#allow_edit_branding ⇒ Object

Returns the value of attribute allow_edit_branding.



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

def allow_edit_branding
  @allow_edit_branding
end

#allow_edit_remote_storage ⇒ Object

Returns the value of attribute allow_edit_remote_storage.



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

def allow_edit_remote_storage
  @allow_edit_remote_storage
end

#prevent_change_password ⇒ Object

Returns the value of attribute prevent_change_password.



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

def prevent_change_password
  @prevent_change_password
end

#prevent_edit_server_settings ⇒ Object

Returns the value of attribute prevent_edit_server_settings.



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

def prevent_edit_server_settings
  @prevent_edit_server_settings
end

#prevent_server_shutdown ⇒ Object

Returns the value of attribute prevent_server_shutdown.



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

def prevent_server_shutdown
  @prevent_server_shutdown
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/comet/models/admin_user_permissions.rb', line 51

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 'PreventEditServerSettings'
      @prevent_edit_server_settings = v
    when 'PreventServerShutdown'
      @prevent_server_shutdown = v
    when 'PreventChangePassword'
      @prevent_change_password = v
    when 'AllowEditBranding'
      @allow_edit_branding = v
    when 'AllowEditRemoteStorage'
      @allow_edit_remote_storage = 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) 


44
45
46
47
48
 
# File 'lib/comet/models/admin_user_permissions.rb', line 44

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



97
98
99
 
# File 'lib/comet/models/admin_user_permissions.rb', line 97

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/comet/models/admin_user_permissions.rb', line 73

def to_hash
  ret = {}
  unless @prevent_edit_server_settings.nil?
    ret['PreventEditServerSettings'] = @prevent_edit_server_settings
  end
  unless @prevent_server_shutdown.nil?
    ret['PreventServerShutdown'] = @prevent_server_shutdown
  end
  unless @prevent_change_password.nil?
    ret['PreventChangePassword'] = @prevent_change_password
  end
  unless @allow_edit_branding.nil?
    ret['AllowEditBranding'] = @allow_edit_branding
  end
  unless @allow_edit_remote_storage.nil?
    ret['AllowEditRemoteStorage'] = @allow_edit_remote_storage
  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



102
103
104
 
# File 'lib/comet/models/admin_user_permissions.rb', line 102

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