Class: Discorb::Gateway::ReactionEvent
- Inherits:
-
GatewayEvent
- Object
- GatewayEvent
- Discorb::Gateway::ReactionEvent
- Defined in:
- lib/discorb/gateway.rb
Overview
Represents a reaction event.
Instance Attribute Summary collapse
- #channel -> nil, Discorb::Channel readonly
-
#channel_id -> Discorb::Snowflake
readonly
The ID of the channel the message was sent in.
-
#data -> Hash
readonly
The raw data of the event.
-
#emoji -> Discorb::UnicodeEmoji, Discorb::PartialEmoji
readonly
The emoji that was reacted with.
- #fired_by -> nil, ... (also: #reactor, #from) readonly
- #guild -> nil, Discorb::Guild readonly
-
#guild_id -> Discorb::Snowflake
readonly
The ID of the guild the message was sent in.
- #member -> nil, Discorb::Member readonly
- #message -> nil, Discorb::Message readonly
-
#message_id -> Discorb::Snowflake
readonly
The ID of the message.
- #user -> nil, Discorb::User readonly
-
#user_id -> Discorb::Snowflake
(also: #member_id)
readonly
The ID of the user who reacted.
Instance Method Summary collapse
-
#fetch_message(force: false) -> Async::Task<Discorb::Message>
Fetch the message.
Instance Attribute Details
#channel -> nil, Discorb::Channel (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
44 45 46 |
# File 'lib/discorb/gateway.rb', line 44 def channel @channel end |
#channel_id -> Discorb::Snowflake (readonly)
Returns The ID of the channel the message was sent in.
34 35 36 |
# File 'lib/discorb/gateway.rb', line 34 def channel_id @channel_id end |
#data -> Hash (readonly)
Returns The raw data of the event.
29 30 31 |
# File 'lib/discorb/gateway.rb', line 29 def data @data end |
#emoji -> Discorb::UnicodeEmoji, Discorb::PartialEmoji (readonly)
Returns The emoji that was reacted with.
55 56 57 |
# File 'lib/discorb/gateway.rb', line 55 def emoji @emoji end |
#fired_by -> nil, ... (readonly) Also known as: reactor, from
This method returns an object from client cache. it will return nil
if the object is not in cache.
58 59 60 |
# File 'lib/discorb/gateway.rb', line 58 def fired_by @fired_by end |
#guild -> nil, Discorb::Guild (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
47 48 49 |
# File 'lib/discorb/gateway.rb', line 47 def guild @guild end |
#guild_id -> Discorb::Snowflake (readonly)
Returns The ID of the guild the message was sent in.
38 39 40 |
# File 'lib/discorb/gateway.rb', line 38 def guild_id @guild_id end |
#member -> nil, Discorb::Member (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
53 54 55 |
# File 'lib/discorb/gateway.rb', line 53 def member @member end |
#message -> nil, Discorb::Message (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
50 51 52 |
# File 'lib/discorb/gateway.rb', line 50 def @message end |
#message_id -> Discorb::Snowflake (readonly)
Returns The ID of the message.
36 37 38 |
# File 'lib/discorb/gateway.rb', line 36 def @message_id end |
#user -> nil, Discorb::User (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
41 42 43 |
# File 'lib/discorb/gateway.rb', line 41 def user @user end |
#user_id -> Discorb::Snowflake (readonly) Also known as: member_id
Returns The ID of the user who reacted.
31 32 33 |
# File 'lib/discorb/gateway.rb', line 31 def user_id @user_id end |
Instance Method Details
#fetch_message(force: false) -> Async::Task<Discorb::Message>
This is an asynchronous method, it will return a Async::Task
object. Use Async::Task#wait
to get the result.
This method calls HTTP request.
Fetch the message. If message is cached, it will be returned.
102 103 104 105 106 107 108 |
# File 'lib/discorb/gateway.rb', line 102 def (force: false) Async do next @message if !force && @message @message = @channel.(@message_id).wait end end |