Class: Discorb::Gateway::ReactionEvent

Inherits:
GatewayEvent show all
Defined in:
lib/discorb/gateway.rb

Overview

Represents a reaction event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel -> nil, Discorb::Channel (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Channel) —

    The channel the message was sent in.



41
42
43
 
# File 'lib/discorb/gateway.rb', line 41

def channel
  @channel
end

#channel_id -> Discorb::Snowflake (readonly)

Returns The ID of the channel the message was sent in.

Returns:



31
32
33
 
# File 'lib/discorb/gateway.rb', line 31

def channel_id
  @channel_id
end

#data -> Hash (readonly)

Returns The raw data of the event.

Returns:

  • (Hash) —

    The raw data of the event.



26
27
28
 
# File 'lib/discorb/gateway.rb', line 26

def data
  @data
end

#emoji -> Discorb::UnicodeEmoji, Discorb::PartialEmoji (readonly)

Returns The emoji that was reacted with.

Returns:



52
53
54
 
# File 'lib/discorb/gateway.rb', line 52

def emoji
  @emoji
end

#guild -> nil, Discorb::Guild (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Guild) —

    The guild the message was sent in.



44
45
46
 
# File 'lib/discorb/gateway.rb', line 44

def guild
  @guild
end

#guild_id -> Discorb::Snowflake (readonly)

Returns The ID of the guild the message was sent in.

Returns:



35
36
37
 
# File 'lib/discorb/gateway.rb', line 35

def guild_id
  @guild_id
end

#member -> nil, Discorb::Member (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Member) —

    The member who reacted.



50
51
52
 
# File 'lib/discorb/gateway.rb', line 50

def member
  @member
end

#message -> nil, Discorb::Message (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::Message) —

    The message the reaction was sent in.



47
48
49
 
# File 'lib/discorb/gateway.rb', line 47

def message
  @message
end

#message_id -> Discorb::Snowflake (readonly)

Returns The ID of the message.

Returns:



33
34
35
 
# File 'lib/discorb/gateway.rb', line 33

def message_id
  @message_id
end

#user -> nil, Discorb::User (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:

  • (nil) —

    The object wasn't cached.

  • (Discorb::User) —

    The user who reacted.



38
39
40
 
# File 'lib/discorb/gateway.rb', line 38

def user
  @user
end

#user_id -> Discorb::Snowflake (readonly) Also known as: member_id

Returns The ID of the user who reacted.

Returns:



28
29
30
 
# File 'lib/discorb/gateway.rb', line 28

def user_id
  @user_id
end

Instance Method Details

#fetch_message(force: false) -> Discorb::Message

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.

Fetch the message. If message is cached, it will be returned.

Parameters:

  • force (Boolean) (defaults to: false) —

    Whether to force fetching the message.

Returns:

Raises:



91
92
93
94
95
96
97
 
# File 'lib/discorb/gateway.rb', line 91

def fetch_message(force: false)
  Async do
    next @message if !force && @message

    @message = @channel.fetch_message(@message_id).wait
  end
end