module Discordrb::EventContainer

This module provides the functionality required for events and awaits. It is separated from the {Bot} class so users can make their own container modules and include them.

Public Class Methods

class_from_string(str) click to toggle source

Utility method to return a class object from a string of its name. Mostly useful for internal stuff @param str [String] The name of the class @return [Class] the class

# File lib/discordrb/container.rb, line 733
def self.class_from_string(str)
  str.split('::').inject(Object) do |mod, class_name|
    mod.const_get(class_name)
  end
end
event_class(handler_class) click to toggle source

Returns the event class for a handler class type @see handler_class @param handler_class [Class] The handler type @return [Class, nil] the event type, or nil if the handler_class isn’t a handler class (i.e. ends with Handler)

# File lib/discordrb/container.rb, line 723
def self.event_class(handler_class)
  class_name = handler_class.to_s
  return nil unless class_name.end_with? 'Handler'

  EventContainer.class_from_string(class_name[0..-8])
end
handler_class(event_class) click to toggle source

Returns the handler class for an event class type @see event_class @param event_class [Class] The event type @return [Class] the handler type

# File lib/discordrb/container.rb, line 715
def self.handler_class(event_class)
  class_from_string("#{event_class}Handler")
end

Public Instance Methods

<<(handler)
Alias for: add_handler
add_handler(handler) click to toggle source

Adds an event handler to this container. Usually, it’s more expressive to just use one of the shorthand adder methods like {#message}, but if you want to create one manually you can use this. @param handler [Discordrb::Events::EventHandler] The handler to add.

# File lib/discordrb/container.rb, line 683
def add_handler(handler)
  clazz = EventContainer.event_class(handler.class)
  @event_handlers ||= {}
  @event_handlers[clazz] ||= []
  @event_handlers[clazz] << handler
end
Also aliased as: <<
application_command(name, attributes = {}, &block) click to toggle source

This event is raised whenever an application command (slash command) is executed. @param name [Symbol] The name of the application command this handler is for. @param attributes [Hash] The event’s attributes. @yield The block is executed when the event is raised. @yieldparam event [ApplicationCommandEvent] The event that was raised. @return [ApplicationCommandEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 546
def application_command(name, attributes = {}, &block)
  @application_commands ||= {}

  unless block
    @application_commands[name] ||= ApplicationCommandEventHandler.new(attributes, nil)
    return @application_commands[name]
  end

  @application_commands[name] = ApplicationCommandEventHandler.new(attributes, block)
end
await(attributes = {}, &block) click to toggle source

This event is raised when an {Await} is triggered. It provides an easy way to execute code on an await without having to rely on the await’s block. @param attributes [Hash] The event’s attributes. @option attributes [Symbol] :key Exactly matches the await’s key. @option attributes [Class] :type Exactly matches the event’s type. @yield The block is executed when the event is raised. @yieldparam event [AwaitEvent] The event that was raised. @return [AwaitEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 476
def await(attributes = {}, &block)
  register_event(AwaitEvent, attributes, block)
end
button(attributes = {}, &block) click to toggle source

This event is raised whenever an button interaction is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :custom_id A custom_id to match against. @option attributes [String, Integer, Message] :message The message to filter for. @yield The block is executed when the event is raised. @yieldparam event [ButtonEvent] The event that was raised. @return [ButtonEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 564
def button(attributes = {}, &block)
  register_event(ButtonEvent, attributes, block)
end
channel_create(attributes = {}, &block) click to toggle source

This event is raised when a channel is created. @param attributes [Hash] The event’s attributes. @option attributes [Integer] :type Matches the type of channel that is being created (0: text, 1: private, 2: voice, 3: group) @option attributes [String] :name Matches the name of the created channel. @yield The block is executed when the event is raised. @yieldparam event [ChannelCreateEvent] The event that was raised. @return [ChannelCreateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 217
def channel_create(attributes = {}, &block)
  register_event(ChannelCreateEvent, attributes, block)
end
channel_delete(attributes = {}, &block) click to toggle source

This event is raised when a channel is deleted. @param attributes [Hash] The event’s attributes. @option attributes [Integer] :type Matches the type of channel that is being deleted (0: text, 1: private, 2: voice, 3: group). @option attributes [String] :name Matches the name of the deleted channel. @yield The block is executed when the event is raised. @yieldparam event [ChannelDeleteEvent] The event that was raised. @return [ChannelDeleteEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 239
def channel_delete(attributes = {}, &block)
  register_event(ChannelDeleteEvent, attributes, block)
end
channel_recipient_add(attributes = {}, &block) click to toggle source

This event is raised when a recipient is added to a group channel. @param attributes [Hash] The event’s attributes. @option attributes [String] :name Matches the name of the group channel that the recipient is added to. @option attributes [String, Integer] :owner_id Matches the ID of the group channel’s owner. @option attributes [String, Integer] :id Matches the ID of the recipient added to the group channel. @yield The block is executed when the event is raised. @yieldparam event [ChannelRecipientAddEvent] The event that was raised. @return [ChannelRecipientAddHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 251
def channel_recipient_add(attributes = {}, &block)
  register_event(ChannelRecipientAddEvent, attributes, block)
end
channel_recipient_remove(attributes = {}, &block) click to toggle source

This event is raised when a recipient is removed from a group channel. @param attributes [Hash] The event’s attributes. @option attributes [String] :name Matches the name of the group channel that the recipient is added to. @option attributes [String, Integer] :owner_id Matches the ID of the group channel’s owner. @option attributes [String, Integer] :id Matches the ID of the recipient removed from the group channel. @yield The block is executed when the event is raised. @yieldparam event [ChannelRecipientRemoveEvent] The event that was raised. @return [ChannelRecipientRemoveHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 263
def channel_recipient_remove(attributes = {}, &block)
  register_event(ChannelRecipientRemoveEvent, attributes, block)
end
channel_select(attributes = {}, &block) click to toggle source

This event is raised whenever an select channel interaction is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :custom_id A custom_id to match against. @option attributes [String, Integer, Message] :message The message to filter for. @yield The block is executed when the event is raised. @yieldparam event [ChannelSelectEvent] The event that was raised. @return [ChannelSelectEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 634
def channel_select(attributes = {}, &block)
  register_event(ChannelSelectEvent, attributes, block)
end
channel_update(attributes = {}, &block) click to toggle source

This event is raised when a channel is updated. @param attributes [Hash] The event’s attributes. @option attributes [Integer] :type Matches the type of channel that is being updated (0: text, 1: private, 2: voice, 3: group). @option attributes [String] :name Matches the new name of the channel. @yield The block is executed when the event is raised. @yieldparam event [ChannelUpdateEvent] The event that was raised. @return [ChannelUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 228
def channel_update(attributes = {}, &block)
  register_event(ChannelUpdateEvent, attributes, block)
end
clear!() click to toggle source

Removes all events from this event handler.

# File lib/discordrb/container.rb, line 675
def clear!
  @event_handlers&.clear
  @application_commands&.clear
end
direct_message(attributes = {}, &block)
Alias for: pm
disconnected(attributes = {}, &block) click to toggle source

This event is raised when the bot has disconnected from the WebSocket, due to the {Bot#stop} method or external causes. It’s the recommended way to do clean-up tasks. @param attributes [Hash] Event attributes, none in this particular case @yield The block is executed when the event is raised. @yieldparam event [DisconnectEvent] The event that was raised. @return [DisconnectEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 58
def disconnected(attributes = {}, &block)
  register_event(DisconnectEvent, attributes, block)
end
dm(attributes = {}, &block)
Alias for: pm
heartbeat(attributes = {}, &block) click to toggle source

This event is raised every time the bot sends a heartbeat over the galaxy. This happens roughly every 40 seconds, but may happen at a lower rate should Discord change their interval. It may also happen more quickly for periods of time, especially for unstable connections, since discordrb rather sends a heartbeat than not if there’s a choice. (You shouldn’t rely on all this to be accurately timed.)

All this makes this event useful to periodically trigger something, like doing some API request every hour, setting some kind of uptime variable or whatever else. The only limit is yourself. @param attributes [Hash] Event attributes, none in this particular case @yield The block is executed when the event is raised. @yieldparam event [HeartbeatEvent] The event that was raised. @return [HeartbeatEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 73
def heartbeat(attributes = {}, &block)
  register_event(HeartbeatEvent, attributes, block)
end
include!(container)
Alias for: include_events
include_events(container) click to toggle source

Adds all event handlers from another container into this one. Existing event handlers will be overwritten. @param container [Module] A module that ‘extend`s {EventContainer} from which the handlers will be added.

# File lib/discordrb/container.rb, line 692
def include_events(container)
  application_command_handlers = container.instance_variable_get(:@application_commands)
  handlers = container.instance_variable_get :@event_handlers
  return unless handlers || application_command_handlers

  @event_handlers ||= {}
  @event_handlers.merge!(handlers || {}) { |_, old, new| old + new }

  @application_commands ||= {}

  @application_commands.merge!(application_command_handlers || {}) do |_, old, new|
    old.subcommands.merge!(new.subcommands)
    old
  end
end
Also aliased as: include!
interaction_create(attributes = {}, &block) click to toggle source

This event is raised whenever an interaction event is received. @param attributes [Hash] The event’s attributes. @option attributes [Integer, Symbol, String] :type The interaction type, can be the integer value or the name

of the key in {Discordrb::Interaction::TYPES}.

@option attributes [String, Integer, Server, nil] :server The server where this event was created. ‘nil` for DM channels. @option attributes [String, Integer, Channel] :channel The channel where this event was created. @option attributes [String, Integer, User] :user The user that triggered this event. @yield The block is executed when the event is raised. @yieldparam event [InteractionCreateEvent] The event that was raised. @return [InteractionCreateEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 536
def interaction_create(attributes = {}, &block)
  register_event(InteractionCreateEvent, attributes, block)
end
invite_create(attributes = {}, &block) click to toggle source

This event is raised when an invite is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, User] :inviter Matches the user that created the invite. @option attributes [String, Integer, Channel] :channel Matches the channel the invite was created for. @option attributes [String, Integer, Server] :server Matches the server the invite was created for. @option attributes [true, false] :temporary Matches whether the invite is temporary or not. @yield The block is executed when the event is raised. @yieldparam event [InviteCreateEvent] The event that was raised. @return [InviteCreateEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 511
def invite_create(attributes = {}, &block)
  register_event(InviteCreateEvent, attributes, block)
end
invite_delete(attributes = {}, &block) click to toggle source

This event is raised when an invite is deleted. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Channel] :channel Matches the channel the deleted invite was for. @option attributes [String, Integer, Server] :server Matches the server the deleted invite was for. @yield The block is executed when the event is raised @yieldparam event [InviteDeleteEvent] The event that was raised. @return [InviteDeleteEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 522
def invite_delete(attributes = {}, &block)
  register_event(InviteDeleteEvent, attributes, block)
end
member_join(attributes = {}, &block) click to toggle source

This event is raised when a new user joins a server. @param attributes [Hash] The event’s attributes. @option attributes [String] :username Matches the username of the joined user. @yield The block is executed when the event is raised. @yieldparam event [ServerMemberAddEvent] The event that was raised. @return [ServerMemberAddEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 300
def member_join(attributes = {}, &block)
  register_event(ServerMemberAddEvent, attributes, block)
end
member_leave(attributes = {}, &block) click to toggle source

This event is raised when a member leaves a server. @param attributes [Hash] The event’s attributes. @option attributes [String] :username Matches the username of the member. @yield The block is executed when the event is raised. @yieldparam event [ServerMemberDeleteEvent] The event that was raised. @return [ServerMemberDeleteEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 321
def member_leave(attributes = {}, &block)
  register_event(ServerMemberDeleteEvent, attributes, block)
end
member_update(attributes = {}, &block) click to toggle source

This event is raised when a member update happens. This includes when a members nickname or roles are updated. @param attributes [Hash] The event’s attributes. @option attributes [String] :username Matches the username of the updated user. @yield The block is executed when the event is raised. @yieldparam event [ServerMemberUpdateEvent] The event that was raised. @return [ServerMemberUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 311
def member_update(attributes = {}, &block)
  register_event(ServerMemberUpdateEvent, attributes, block)
end
mention(attributes = {}, &block) click to toggle source

This event is raised when the bot is mentioned in a message. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :start_with Matches the string the message starts with. @option attributes [String, Regexp] :end_with Matches the string the message ends with. @option attributes [String, Regexp] :contains Matches a string the message contains. @option attributes [String, Integer, Channel] :in Matches the channel the message was sent in. @option attributes [String, Integer, User] :from Matches the user that sent the message. @option attributes [String] :content Exactly matches the entire content of the message. @option attributes [Time] :after Matches a time after the time the message was sent at. @option attributes [Time] :before Matches a time before the time the message was sent at. @option attributes [Boolean] :private Matches whether or not the channel is private. @yield The block is executed when the event is raised. @yieldparam event [MentionEvent] The event that was raised. @return [MentionEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 206
def mention(attributes = {}, &block)
  register_event(MentionEvent, attributes, block)
end
mentionable_select(attributes = {}, &block) click to toggle source

This event is raised whenever an select mentionable interaction is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :custom_id A custom_id to match against. @option attributes [String, Integer, Message] :message The message to filter for. @yield The block is executed when the event is raised. @yieldparam event [MentionableSelectEvent] The event that was raised. @return [MentionableSelectEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 623
def mentionable_select(attributes = {}, &block)
  register_event(MentionableSelectEvent, attributes, block)
end
message(attributes = {}, &block) click to toggle source

This event is raised when a message is sent to a text channel the bot is currently in. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :start_with Matches the string the message starts with. @option attributes [String, Regexp] :end_with Matches the string the message ends with. @option attributes [String, Regexp] :contains Matches a string the message contains. @option attributes [String, Integer, Channel] :in Matches the channel the message was sent in. @option attributes [String, Integer, User] :from Matches the user that sent the message. @option attributes [String] :content Exactly matches the entire content of the message. @option attributes [Time] :after Matches a time after the time the message was sent at. @option attributes [Time] :before Matches a time before the time the message was sent at. @option attributes [Boolean] :private Matches whether or not the channel is private. @yield The block is executed when the event is raised. @yieldparam event [MessageEvent] The event that was raised. @return [MessageEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 38
def message(attributes = {}, &block)
  register_event(MessageEvent, attributes, block)
end
message_delete(attributes = {}, &block) click to toggle source

This event is raised when a message is deleted in a channel. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer] :id Matches the ID of the message that was deleted. @option attributes [String, Integer, Channel] :in Matches the channel the message was deleted in. @yield The block is executed when the event is raised. @yieldparam event [MessageDeleteEvent] The event that was raised. @return [MessageDeleteEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 110
def message_delete(attributes = {}, &block)
  register_event(MessageDeleteEvent, attributes, block)
end
message_edit(attributes = {}, &block) click to toggle source

This event is raised when a message is edited in a channel. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer] :id Matches the ID of the message that was edited. @option attributes [String, Integer, Channel] :in Matches the channel the message was edited in. @yield The block is executed when the event is raised. @yieldparam event [MessageEditEvent] The event that was raised. @return [MessageEditEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 99
def message_edit(attributes = {}, &block)
  register_event(MessageEditEvent, attributes, block)
end
message_update(attributes = {}, &block) click to toggle source

This event is raised whenever a message is updated. Message updates can be triggered from a user editing their own message, or from Discord automatically attaching embeds to the user’s message for URLs contained in the message’s content. If you only want to listen for users editing their own messages, use the {message_edit} handler instead. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer] :id Matches the ID of the message that was updated. @option attributes [String, Integer, Channel] :in Matches the channel the message was updated in. @yield The block is executed when the event is raised. @yieldparam event [MessageUpdateEvent] The event that was raised. @return [MessageUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 124
def message_update(attributes = {}, &block)
  register_event(MessageUpdateEvent, attributes, block)
end
modal_submit(attributes = {}, &block) click to toggle source

This event is raised whenever a modal is submitted. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :custom_id A custom_id to match against. @option attributes [String, Integer, Message] :message The message to filter for. @option attributes [String, Integer, Server, nil] :server The server where this event was created. ‘nil` for DM channels. @option attributes [String, Integer, Channel] :channel The channel where this event was created. @option attributes [String, Integer, User] :user The user that triggered this event. # @yield The block is executed when the event is raised. @yieldparam event [ModalSubmitEvent] The event that was raised. @return [ModalSubmitEventHandler] The event handler that was registered.

playing(attributes = {}, &block) click to toggle source

This event is raised when the game a user is playing changes. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, User] :from Matches the user whose playing game changes. @option attributes [String] :game Matches the game the user is now playing. @option attributes [Integer] :type Matches the type of game object (0 game, 1 Twitch stream) @yield The block is executed when the event is raised. @yieldparam event [PlayingEvent] The event that was raised. @return [PlayingEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 188
def playing(attributes = {}, &block)
  register_event(PlayingEvent, attributes, block)
end
pm(attributes = {}, &block) click to toggle source

This event is raised when a private message is sent to the bot. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :start_with Matches the string the message starts with. @option attributes [String, Regexp] :end_with Matches the string the message ends with. @option attributes [String, Regexp] :contains Matches a string the message contains. @option attributes [String, Integer, Channel] :in Matches the channel the message was sent in. @option attributes [String, Integer, User] :from Matches the user that sent the message. @option attributes [String] :content Exactly matches the entire content of the message. @option attributes [Time] :after Matches a time after the time the message was sent at. @option attributes [Time] :before Matches a time before the time the message was sent at. @option attributes [Boolean] :private Matches whether or not the channel is private. @yield The block is executed when the event is raised. @yieldparam event [PrivateMessageEvent] The event that was raised. @return [PrivateMessageEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 494
def pm(attributes = {}, &block)
  register_event(PrivateMessageEvent, attributes, block)
end
Also aliased as: private_message, direct_message, dm
presence(attributes = {}, &block) click to toggle source

This event is raised when a user’s status (online/offline/idle) changes. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, User] :from Matches the user whose status changed. @option attributes [:offline, :idle, :online] :status Matches the status the user has now. @option attributes [Hash<Symbol, Symbol>] :client_status Matches the current online status (‘:online`, `:idle` or `:dnd`) of the user

on various device types (`:desktop`, `:mobile`, or `:web`). The value will be `nil` when the user is offline or invisible

@yield The block is executed when the event is raised. @yieldparam event [PresenceEvent] The event that was raised. @return [PresenceEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 176
def presence(attributes = {}, &block)
  register_event(PresenceEvent, attributes, block)
end
private_message(attributes = {}, &block)
Alias for: pm
raw(attributes = {}, &block) click to toggle source

This event is raised for every dispatch received over the gateway, whether supported by discordrb or not. @param attributes [Hash] The event’s attributes. @option attributes [String, Symbol, Regexp] :type Matches the event type of the dispatch. @yield The block is executed when the event is raised. @yieldparam event [RawEvent] The event that was raised. @return [RawEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 644
def raw(attributes = {}, &block)
  register_event(RawEvent, attributes, block)
end
reaction_add(attributes = {}, &block) click to toggle source

This event is raised when somebody reacts to a message. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer] :emoji Matches the ID of the emoji that was reacted with, or its name. @option attributes [String, Integer, User] :from Matches the user who added the reaction. @option attributes [String, Integer, Message] :message Matches the message to which the reaction was added. @option attributes [String, Integer, Channel] :in Matches the channel the reaction was added in. @yield The block is executed when the event is raised. @yieldparam event [ReactionAddEvent] The event that was raised. @return [ReactionAddEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 137
def reaction_add(attributes = {}, &block)
  register_event(ReactionAddEvent, attributes, block)
end
reaction_remove(attributes = {}, &block) click to toggle source

This event is raised when somebody removes a reaction from a message. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer] :emoji Matches the ID of the emoji that was removed from the reactions, or

its name.

@option attributes [String, Integer, User] :from Matches the user who removed the reaction. @option attributes [String, Integer, Message] :message Matches the message to which the reaction was removed. @option attributes [String, Integer, Channel] :in Matches the channel the reaction was removed in. @yield The block is executed when the event is raised. @yieldparam event [ReactionRemoveEvent] The event that was raised. @return [ReactionRemoveEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 151
def reaction_remove(attributes = {}, &block)
  register_event(ReactionRemoveEvent, attributes, block)
end
reaction_remove_all(attributes = {}, &block) click to toggle source

This event is raised when somebody removes all reactions from a message. @param attributes [Hash] The event’s attributes. @option attributes [Hash] The event’s attributes. @option attributes [String, Integer, Message] :message Matches the message to which the reactions were removed. @option attributes [String, Integer, Channel] :in Matches the channel the reactions were removed in. @yield The block is executed when the event is raised. @yieldparam event [ReactionRemoveAllEvent] The event that was raised. @return [ReactionRemoveAllEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 163
def reaction_remove_all(attributes = {}, &block)
  register_event(ReactionRemoveAllEvent, attributes, block)
end
ready(attributes = {}, &block) click to toggle source

This event is raised when the READY packet is received, i.e. servers and channels have finished initialization. It’s the recommended way to do things when the bot has finished starting up. @param attributes [Hash] Event attributes, none in this particular case @yield The block is executed when the event is raised. @yieldparam event [ReadyEvent] The event that was raised. @return [ReadyEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 48
def ready(attributes = {}, &block)
  register_event(ReadyEvent, attributes, block)
end
remove_application_command_handler(name) click to toggle source

Remove an application command handler @param name [String, Symbol] The name of the command handler to remove.

# File lib/discordrb/container.rb, line 670
def remove_application_command_handler(name)
  @application_commands.delete(name)
end
remove_handler(handler) click to toggle source

Removes an event handler from this container. If you’re looking for a way to do temporary events, I recommend {Await}s instead of this. @param handler [Discordrb::Events::EventHandler] The handler to remove.

# File lib/discordrb/container.rb, line 662
def remove_handler(handler)
  clazz = EventContainer.event_class(handler.class)
  @event_handlers ||= {}
  @event_handlers[clazz].delete(handler)
end
role_select(attributes = {}, &block) click to toggle source

This event is raised whenever an select role interaction is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :custom_id A custom_id to match against. @option attributes [String, Integer, Message] :message The message to filter for. @yield The block is executed when the event is raised. @yieldparam event [RoleSelectEvent] The event that was raised. @return [RoleSelectEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 612
def role_select(attributes = {}, &block)
  register_event(RoleSelectEvent, attributes, block)
end
select_menu(attributes = {}, &block)
Alias for: string_select
server_create(attributes = {}, &block) click to toggle source

This event is raised when a server is created respective to the bot, i.e. the bot joins a server or creates a new one itself. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server that was created. @yield The block is executed when the event is raised. @yieldparam event [ServerCreateEvent] The event that was raised. @return [ServerCreateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 354
def server_create(attributes = {}, &block)
  register_event(ServerCreateEvent, attributes, block)
end
server_delete(attributes = {}, &block) click to toggle source

This event is raised when a server is deleted, or when the bot leaves a server. (These two cases are identical to Discord.) @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server that was deleted. @yield The block is executed when the event is raised. @yieldparam event [ServerDeleteEvent] The event that was raised. @return [ServerDeleteEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 375
def server_delete(attributes = {}, &block)
  register_event(ServerDeleteEvent, attributes, block)
end
server_emoji(attributes = {}, &block) click to toggle source

This event is raised when an emoji or collection of emojis is created/deleted/updated. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server. @yield The block is executed when the event is raised. @yieldparam event [ServerEmojiChangeEvent] The event that was raised. @return [ServerEmojiChangeEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 385
def server_emoji(attributes = {}, &block)
  register_event(ServerEmojiChangeEvent, attributes, block)
end
server_emoji_create(attributes = {}, &block) click to toggle source

This event is raised when an emoji is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server. @option attributes [String, Integer] :id Matches the ID of the emoji. @option attributes [String] :name Matches the name of the emoji. @yield The block is executed when the event is raised. @yieldparam event [ServerEmojiCreateEvent] The event that was raised. @return [ServerEmojiCreateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 397
def server_emoji_create(attributes = {}, &block)
  register_event(ServerEmojiCreateEvent, attributes, block)
end
server_emoji_delete(attributes = {}, &block) click to toggle source

This event is raised when an emoji is deleted. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server. @option attributes [String, Integer] :id Matches the ID of the emoji. @option attributes [String] :name Matches the name of the emoji. @yield The block is executed when the event is raised. @yieldparam event [ServerEmojiDeleteEvent] The event that was raised. @return [ServerEmojiDeleteEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 409
def server_emoji_delete(attributes = {}, &block)
  register_event(ServerEmojiDeleteEvent, attributes, block)
end
server_emoji_update(attributes = {}, &block) click to toggle source

This event is raised when an emoji is updated. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server. @option attributes [String, Integer] :id Matches the ID of the emoji. @option attributes [String] :name Matches the name of the emoji. @option attributes [String] :old_name Matches the name of the emoji before the update. @yield The block is executed when the event is raised. @yieldparam event [ServerEmojiUpdateEvent] The event that was raised. @return [ServerEmojiUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 422
def server_emoji_update(attributes = {}, &block)
  register_event(ServerEmojiUpdateEvent, attributes, block)
end
server_role_create(attributes = {}, &block) click to toggle source

This event is raised when a role is created. @param attributes [Hash] The event’s attributes. @option attributes [String] :name Matches the role name. @yield The block is executed when the event is raised. @yieldparam event [ServerRoleCreateEvent] The event that was raised. @return [ServerRoleCreateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 432
def server_role_create(attributes = {}, &block)
  register_event(ServerRoleCreateEvent, attributes, block)
end
server_role_delete(attributes = {}, &block) click to toggle source

This event is raised when a role is deleted. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer] :id Matches the role ID. @yield The block is executed when the event is raised. @yieldparam event [ServerRoleDeleteEvent] The event that was raised. @return [ServerRoleDeleteEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 442
def server_role_delete(attributes = {}, &block)
  register_event(ServerRoleDeleteEvent, attributes, block)
end
server_role_update(attributes = {}, &block) click to toggle source

This event is raised when a role is updated. @param attributes [Hash] The event’s attributes. @option attributes [String] :name Matches the role name. @yield The block is executed when the event is raised. @yieldparam event [ServerRoleUpdateEvent] The event that was raised. @return [ServerRoleUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 452
def server_role_update(attributes = {}, &block)
  register_event(ServerRoleUpdateEvent, attributes, block)
end
server_update(attributes = {}, &block) click to toggle source

This event is raised when a server is updated, for example if the name or region has changed. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server that was updated. @yield The block is executed when the event is raised. @yieldparam event [ServerUpdateEvent] The event that was raised. @return [ServerUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 364
def server_update(attributes = {}, &block)
  register_event(ServerUpdateEvent, attributes, block)
end
string_select(attributes = {}, &block) click to toggle source

This event is raised whenever an select string interaction is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :custom_id A custom_id to match against. @option attributes [String, Integer, Message] :message The message to filter for. @yield The block is executed when the event is raised. @yieldparam event [StringSelectEvent] The event that was raised. @return [StringSelectEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 575
def string_select(attributes = {}, &block)
  register_event(StringSelectEvent, attributes, block)
end
Also aliased as: select_menu
typing(attributes = {}, &block) click to toggle source

This event is raised when somebody starts typing in a channel the bot is also in. The official Discord client would display the typing indicator for five seconds after receiving this event. If the user continues typing after five seconds, the event will be re-raised. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Channel] :in Matches the channel where typing was started. @option attributes [String, Integer, User] :from Matches the user that started typing. @option attributes [Time] :after Matches a time after the time the typing started. @option attributes [Time] :before Matches a time before the time the typing started. @yield The block is executed when the event is raised. @yieldparam event [TypingEvent] The event that was raised. @return [TypingEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 88
def typing(attributes = {}, &block)
  register_event(TypingEvent, attributes, block)
end
unknown(attributes = {}, &block) click to toggle source

This event is raised for a dispatch received over the gateway that is not currently handled otherwise by discordrb. @param attributes [Hash] The event’s attributes. @option attributes [String, Symbol, Regexp] :type Matches the event type of the dispatch. @yield The block is executed when the event is raised. @yieldparam event [UnknownEvent] The event that was raised. @return [UnknownEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 655
def unknown(attributes = {}, &block)
  register_event(UnknownEvent, attributes, block)
end
user_ban(attributes = {}, &block) click to toggle source

This event is raised when a user is banned from a server. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, User] :user Matches the user that was banned. @option attributes [String, Integer, Server] :server Matches the server from which the user was banned. @yield The block is executed when the event is raised. @yieldparam event [UserBanEvent] The event that was raised. @return [UserBanEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 332
def user_ban(attributes = {}, &block)
  register_event(UserBanEvent, attributes, block)
end
user_select(attributes = {}, &block) click to toggle source

This event is raised whenever an select user interaction is created. @param attributes [Hash] The event’s attributes. @option attributes [String, Regexp] :custom_id A custom_id to match against. @option attributes [String, Integer, Message] :message The message to filter for. @yield The block is executed when the event is raised. @yieldparam event [UserSelectEvent] The event that was raised. @return [UserSelectEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 601
def user_select(attributes = {}, &block)
  register_event(UserSelectEvent, attributes, block)
end
user_unban(attributes = {}, &block) click to toggle source

This event is raised when a user is unbanned from a server. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, User] :user Matches the user that was unbanned. @option attributes [String, Integer, Server] :server Matches the server from which the user was unbanned. @yield The block is executed when the event is raised. @yieldparam event [UserUnbanEvent] The event that was raised. @return [UserUnbanEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 343
def user_unban(attributes = {}, &block)
  register_event(UserUnbanEvent, attributes, block)
end
voice_server_update(attributes = {}, &block) click to toggle source

This event is raised when first connecting to a server’s voice channel. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, User] :from Matches the server that the update is for. @yield The block is executed when the event is raised. @yieldparam event [VoiceServerUpdateEvent] The event that was raised. @return [VoiceServerUpdateEventHandler] The event handler that was registered.

# File lib/discordrb/container.rb, line 290
def voice_server_update(attributes = {}, &block)
  register_event(VoiceServerUpdateEvent, attributes, block)
end
voice_state_update(attributes = {}, &block) click to toggle source

This event is raised when a user’s voice state changes. This includes when a user joins, leaves, or moves between voice channels, as well as their mute and deaf status for themselves and on the server. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, User] :from Matches the user that sent the message. @option attributes [String, Integer, Channel] :channel Matches the voice channel the user has joined. @option attributes [String, Integer, Channel] :old_channel Matches the voice channel the user was in previously. @option attributes [true, false] :mute Matches whether or not the user is muted server-wide. @option attributes [true, false] :deaf Matches whether or not the user is deafened server-wide. @option attributes [true, false] :self_mute Matches whether or not the user is muted by the bot. @option attributes [true, false] :self_deaf Matches whether or not the user is deafened by the bot. @yield The block is executed when the event is raised. @yieldparam event [VoiceStateUpdateEvent] The event that was raised. @return [VoiceStateUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 280
def voice_state_update(attributes = {}, &block)
  register_event(VoiceStateUpdateEvent, attributes, block)
end
webhook_update(attributes = {}, &block) click to toggle source

This event is raised when a webhook is updated. @param attributes [Hash] The event’s attributes. @option attributes [String, Integer, Server] :server Matches the server by name, ID or instance. @option attributes [String, Integer, Channel] :channel Matches the channel by name, ID or instance. @option attribute [String, Integer, Webhook] :webhook Matches the webhook by name, ID or instance. @yield The block is executed when the event is raised. @yieldparam event [WebhookUpdateEvent] The event that was raised. @return [WebhookUpdateEventHandler] the event handler that was registered.

# File lib/discordrb/container.rb, line 464
def webhook_update(attributes = {}, &block)
  register_event(WebhookUpdateEvent, attributes, block)
end

Private Instance Methods

register_event(clazz, attributes, block) click to toggle source

@return [EventHandler]

# File lib/discordrb/container.rb, line 744
def register_event(clazz, attributes, block)
  handler = EventContainer.handler_class(clazz).new(attributes, block)

  @event_handlers ||= {}
  @event_handlers[clazz] ||= []
  @event_handlers[clazz] << handler

  # Return the handler so it can be removed later
  handler
end