Class: GetStream::Generated::Models::Permission

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/permission.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ Permission

Initialize with attributes



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 44

def initialize(attributes = {})
  super(attributes)
  @action = attributes[:action] || attributes['action']
  @custom = attributes[:custom] || attributes['custom']
  @description = attributes[:description] || attributes['description']
  @id = attributes[:id] || attributes['id']
  @level = attributes[:level] || attributes['level']
  @name = attributes[:name] || attributes['name']
  @owner = attributes[:owner] || attributes['owner']
  @same_team = attributes[:same_team] || attributes['same_team']
  @tags = attributes[:tags] || attributes['tags']
  @condition = attributes[:condition] || attributes['condition'] || nil
end

Instance Attribute Details

#action ⇒ String

Returns Action name this permission is for (e.g. SendMessage).

Returns:

  • (String) —

    Action name this permission is for (e.g. SendMessage)



14
15
16
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 14

def action
  @action
end

#condition ⇒ Object

Returns MongoDB style condition which decides whether or not the permission is granted.

Returns:

  • (Object) —

    MongoDB style condition which decides whether or not the permission is granted



41
42
43
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 41

def condition
  @condition
end

#custom ⇒ Boolean

Returns Whether this is a custom permission or built-in.

Returns:

  • (Boolean) —

    Whether this is a custom permission or built-in



17
18
19
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 17

def custom
  @custom
end

#description ⇒ String

Returns Description of the permission.

Returns:

  • (String) —

    Description of the permission



20
21
22
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 20

def description
  @description
end

#id ⇒ String

Returns Unique permission ID.

Returns:

  • (String) —

    Unique permission ID



23
24
25
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 23

def id
  @id
end

#level ⇒ String

Returns Level at which permission could be applied (app or channel).

Returns:

  • (String) —

    Level at which permission could be applied (app or channel)



26
27
28
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 26

def level
  @level
end

#name ⇒ String

Returns Name of the permission.

Returns:

  • (String) —

    Name of the permission



29
30
31
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 29

def name
  @name
end

#owner ⇒ Boolean

Returns Whether this permission applies to resource owner or not.

Returns:

  • (Boolean) —

    Whether this permission applies to resource owner or not



32
33
34
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 32

def owner
  @owner
end

#same_team ⇒ Boolean

Returns Whether this permission applies to teammates (multi-tenancy mode only).

Returns:

  • (Boolean) —

    Whether this permission applies to teammates (multi-tenancy mode only)



35
36
37
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 35

def same_team
  @same_team
end

#tags ⇒ Array<String>

Returns List of tags of the permission.

Returns:

  • (Array<String>) —

    List of tags of the permission



38
39
40
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 38

def tags
  @tags
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/getstream_ruby/generated/models/permission.rb', line 59

def self.json_field_mappings
  {
    action: 'action',
    custom: 'custom',
    description: 'description',
    id: 'id',
    level: 'level',
    name: 'name',
    owner: 'owner',
    same_team: 'same_team',
    tags: 'tags',
    condition: 'condition'
  }
end