Class: Discordrb::Events::ApplicationCommandEvent

Inherits:
InteractionCreateEvent show all
Defined in:
lib/discordrb/events/interactions.rb

Overview

Event for ApplicationCommand interactions.

Direct Known Subclasses

AutocompleteEvent

Defined Under Namespace

Classes: Resolved

Instance Attribute Summary collapse

Attributes inherited from InteractionCreateEvent

#channel, #channel_id, #interaction, #server, #server_id, #type, #user

Attributes inherited from Event

#bot

Instance Method Summary collapse

Methods inherited from InteractionCreateEvent

#defer, #defer_update, #delete_message, #delete_response, #edit_message, #edit_response, #get_component, #respond, #send_message, #show_modal, #update_message

Instance Attribute Details

#command_idInteger (readonly)

Returns The ID of the command.

Returns:

  • (Integer)

    The ID of the command.



142
143
144
# File 'lib/discordrb/events/interactions.rb', line 142

def command_id
  @command_id
end

#command_nameSymbol (readonly)

Returns The name of the command.

Returns:

  • (Symbol)

    The name of the command.



139
140
141
# File 'lib/discordrb/events/interactions.rb', line 139

def command_name
  @command_name
end

#optionsHash<Symbol, Object> (readonly)

Returns Arguments provided to the command, mapped as Name => Value.

Returns:

  • (Hash<Symbol, Object>)

    Arguments provided to the command, mapped as Name => Value.



154
155
156
# File 'lib/discordrb/events/interactions.rb', line 154

def options
  @options
end

#resolvedResolved (readonly)

Returns:



151
152
153
# File 'lib/discordrb/events/interactions.rb', line 151

def resolved
  @resolved
end

#subcommandSymbol? (readonly)

Returns The name of the subcommand relevant to this event.

Returns:

  • (Symbol, nil)

    The name of the subcommand relevant to this event.



148
149
150
# File 'lib/discordrb/events/interactions.rb', line 148

def subcommand
  @subcommand
end

#subcommand_groupSymbol? (readonly)

Returns The name of the subcommand group relevant to this event.

Returns:

  • (Symbol, nil)

    The name of the subcommand group relevant to this event.



145
146
147
# File 'lib/discordrb/events/interactions.rb', line 145

def subcommand_group
  @subcommand_group
end

#target_idInteger? (readonly)

Returns The target of this command when it is a context command.

Returns:

  • (Integer, nil)

    The target of this command when it is a context command.



157
158
159
# File 'lib/discordrb/events/interactions.rb', line 157

def target_id
  @target_id
end

Instance Method Details

#targetMessage, ...

Returns The target of this command, for context commands.

Returns:

  • (Message, User, nil)

    The target of this command, for context commands.



195
196
197
198
199
# File 'lib/discordrb/events/interactions.rb', line 195

def target
  return nil unless @target_id

  @resolved.find { |data| data.key?(@target_id) }[@target_id]
end