Class: Discorb::Role

Inherits:
DiscordModel show all
Includes:
Comparable
Defined in:
lib/discorb/role.rb

Overview

Represents a role in the guild.

Defined Under Namespace

Classes: Tag

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DiscordModel

#==, #eql?, #hash

Instance Attribute Details

#color -> Discorb::Color (readonly)

Returns The color of the role.

Returns:



13
14
15
 
# File 'lib/discorb/role.rb', line 13

def color
  @color
end

#guild -> Discorb::Guild (readonly)

Returns The guild this role belongs to.

Returns:



19
20
21
 
# File 'lib/discorb/role.rb', line 19

def guild
  @guild
end

#hoist -> Boolean (readonly) Also known as: hoist?

Returns Whether the role is hoisted.

Returns:

  • (Boolean) —

    Whether the role is hoisted.



21
22
23
 
# File 'lib/discorb/role.rb', line 21

def hoist
  @hoist
end

#id -> Discorb::Snowflake (readonly)

Returns The ID of the role.

Returns:



9
10
11
 
# File 'lib/discorb/role.rb', line 9

def id
  @id
end

#managed -> Boolean (readonly) Also known as: managed?

Returns Whether the role is managed.

Returns:

  • (Boolean) —

    Whether the role is managed.



24
25
26
 
# File 'lib/discorb/role.rb', line 24

def managed
  @managed
end

#mentionable -> Boolean (readonly) Also known as: mentionable?

Returns Whether the role is a default role.

Returns:

  • (Boolean) —

    Whether the role is a default role.



27
28
29
 
# File 'lib/discorb/role.rb', line 27

def mentionable
  @mentionable
end

#name -> String (readonly)

Returns The name of the role.

Returns:

  • (String) —

    The name of the role.



11
12
13
 
# File 'lib/discorb/role.rb', line 11

def name
  @name
end

#permissions -> Discorb::Permission (readonly)

Returns The permissions of the role.

Returns:



15
16
17
 
# File 'lib/discorb/role.rb', line 15

def permissions
  @permissions
end

#position -> Integer (readonly)

Returns The position of the role.

Returns:

  • (Integer) —

    The position of the role.



17
18
19
 
# File 'lib/discorb/role.rb', line 17

def position
  @position
end

Instance Method Details

#<=>(other) -> Integer

Compares two roles by their position.

Parameters:

Returns:

  • (Integer) —

    -1 if the other role is higher, 0 if they are equal, 1 if the other role is lower.



54
55
56
57
58
 
# File 'lib/discorb/role.rb', line 54

def <=>(other)
  return false unless other.is_a?(Role)

  @position <=> other.position
end

#color? -> Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/discorb/role.rb', line 73

def color?
  @color != 0
end

#delete!(reason: nil) -> Object Also known as: destroy!

Deletes the role.

Parameters:

  • reason (String) (defaults to: nil) —

    The reason for deleting the role.



127
128
129
130
131
 
# File 'lib/discorb/role.rb', line 127

def delete!(reason: nil)
  Async do
    @client.http.delete("/guilds/#{@guild_id}/roles/#{@id}", reason: reason).wait
  end
end

#edit(name: :unset, position: :unset, color: :unset, hoist: :unset, mentionable: :unset, reason: nil) -> Object Also known as: modify

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Note:

The arguments of this method are defaultly set to :unset. Specify value to set the value, if not don't specify or specify :unset.

Edits the role.

Parameters:

  • name (String) (defaults to: :unset) —

    The new name of the role.

  • position (Integer) (defaults to: :unset) —

    The new position of the role.

  • color (Discorb::Color) (defaults to: :unset) —

    The new color of the role.

  • hoist (Boolean) (defaults to: :unset) —

    Whether the role should be hoisted.

  • mentionable (Boolean) (defaults to: :unset) —

    Whether the role should be mentionable.

  • reason (String) (defaults to: nil) —

    The reason for editing the role.

Raises:



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/discorb/role.rb', line 108

def edit(name: :unset, position: :unset, color: :unset, hoist: :unset, mentionable: :unset, reason: nil)
  Async do
    payload = {}
    payload[:name] = name if name != :unset
    payload[:position] = position if position != :unset
    payload[:color] = color.to_i if color != :unset
    payload[:hoist] = hoist if hoist != :unset
    payload[:mentionable] = mentionable if mentionable != :unset
    @client.http.patch("/guilds/#{@guild_id}/roles/#{@id}", payload, reason: reason).wait
  end
end

#inspect -> Object 



77
78
79
 
# File 'lib/discorb/role.rb', line 77

def inspect
  "#<#{self.class} @#{@name} id=#{@id}>"
end

#mention -> Object 



69
70
71
 
# File 'lib/discorb/role.rb', line 69

def mention
  "<@&#{@id}>"
end

#move(position, reason: nil) -> Object

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Moves the role to a new position.

Parameters:

  • position (Integer) —

    The new position.

  • reason (String) (defaults to: nil) —

    The reason for moving the role.

Raises:



89
90
91
92
93
 
# File 'lib/discorb/role.rb', line 89

def move(position, reason: nil)
  Async do
    @client.http.patch("/guilds/#{@guild_id}/roles", { id: @id, position: position }, reason: reason).wait
  end
end

#tag -> Object Also known as: tags 



135
136
137
 
# File 'lib/discorb/role.rb', line 135

def tag
  Tag.new(@tags)
end

#to_s -> String

Formats the role as a string.

Returns:

  • (String) —

    The formatted string.



65
66
67
 
# File 'lib/discorb/role.rb', line 65

def to_s
  "@#{@name}"
end