Class: Discordrb::Reaction
- Inherits:
-
Object
- Object
- Discordrb::Reaction
- Defined in:
- lib/discordrb/data/reaction.rb
Overview
A reaction to a message.
Instance Attribute Summary collapse
-
#count ⇒ Integer
readonly
The amount of users who have reacted with this reaction.
-
#id ⇒ Integer
readonly
The ID of the emoji, if it was custom.
-
#me ⇒ true, false
(also: #me?)
readonly
Whether the current bot or user used this reaction.
-
#name ⇒ String
readonly
The name or unicode representation of the emoji.
Instance Method Summary collapse
-
#to_s ⇒ String
Converts this Reaction into a string that can be sent back to Discord in other reaction endpoints.
Instance Attribute Details
#count ⇒ Integer (readonly)
Returns the amount of users who have reacted with this reaction.
7 8 9 |
# File 'lib/discordrb/data/reaction.rb', line 7 def count @count end |
#id ⇒ Integer (readonly)
Returns the ID of the emoji, if it was custom.
14 15 16 |
# File 'lib/discordrb/data/reaction.rb', line 14 def id @id end |
#me ⇒ true, false (readonly) Also known as: me?
Returns whether the current bot or user used this reaction.
10 11 12 |
# File 'lib/discordrb/data/reaction.rb', line 10 def me @me end |
#name ⇒ String (readonly)
Returns the name or unicode representation of the emoji.
17 18 19 |
# File 'lib/discordrb/data/reaction.rb', line 17 def name @name end |
Instance Method Details
#to_s ⇒ String
Converts this Reaction into a string that can be sent back to Discord in other reaction endpoints.
If ID is present, it will be rendered into the form of name:id
.
30 31 32 |
# File 'lib/discordrb/data/reaction.rb', line 30 def to_s id.nil? ? name : "#{name}:#{id}" end |