Class: Discordrb::Events::ApplicationCommandEvent

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

Overview

Event for ApplicationCommand interactions.

Direct Known Subclasses

AutocompleteEvent

Instance Attribute Summary collapse

Attributes inherited from InteractionCreateEvent

#channel, #channel_id, #context, #interaction, #server, #server_id, #server_integration?, #type, #user, #user_integration?, #user_locale

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_id ⇒ Integer (readonly)

Returns The ID of the command.

Returns:

  • (Integer) —

    The ID of the command.



178
179
180
 
# File 'lib/discordrb/events/interactions.rb', line 178

def command_id
  @command_id
end

#command_name ⇒ Symbol (readonly)

Returns The name of the command.

Returns:

  • (Symbol) —

    The name of the command.



175
176
177
 
# File 'lib/discordrb/events/interactions.rb', line 175

def command_name
  @command_name
end

#options ⇒ Hash<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.



190
191
192
 
# File 'lib/discordrb/events/interactions.rb', line 190

def options
  @options
end

#resolved ⇒ Resolved (readonly)

Returns The resolved channels, roles, users, members, and attachments for this event.

Returns:

  • (Resolved) —

    The resolved channels, roles, users, members, and attachments for this event.



187
188
189
 
# File 'lib/discordrb/events/interactions.rb', line 187

def resolved
  @resolved
end

#subcommand ⇒ Symbol? (readonly)

Returns The name of the subcommand relevant to this event.

Returns:

  • (Symbol, nil) —

    The name of the subcommand relevant to this event.



184
185
186
 
# File 'lib/discordrb/events/interactions.rb', line 184

def subcommand
  @subcommand
end

#subcommand_group ⇒ Symbol? (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.



181
182
183
 
# File 'lib/discordrb/events/interactions.rb', line 181

def subcommand_group
  @subcommand_group
end

#target_id ⇒ Integer? (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.



193
194
195
 
# File 'lib/discordrb/events/interactions.rb', line 193

def target_id
  @target_id
end

Instance Method Details

#options_attachment(name) ⇒ Attachment

Parameters:

  • name (String) —

    The name of the option.

Returns:



269
270
271
 
# File 'lib/discordrb/events/interactions.rb', line 269

def options_attachment(name)
  @resolved[:attachments][@options[name].to_i]
end

#options_channel(name) ⇒ Channel

Parameters:

  • name (String) —

    The name of the option.

Returns:



257
258
259
 
# File 'lib/discordrb/events/interactions.rb', line 257

def options_channel(name)
  @resolved[:channels][@options[name].to_i]
end

#options_member(name) ⇒ Member

Parameters:

  • name (String) —

    The name of the option.

Returns:



245
246
247
 
# File 'lib/discordrb/events/interactions.rb', line 245

def options_member(name)
  @resolved[:members][@options[name].to_i]
end

#options_mentionable(name) ⇒ Member, Role

Parameters:

  • name (String) —

    The name of the option.

Returns:



263
264
265
 
# File 'lib/discordrb/events/interactions.rb', line 263

def options_mentionable(name)
  member(name) || role(name)
end

#options_role(name) ⇒ Role

Parameters:

  • name (String) —

    The name of the option.

Returns:



251
252
253
 
# File 'lib/discordrb/events/interactions.rb', line 251

def options_role(name)
  @resolved[:roles][@options[name].to_i]
end

#options_user(name) ⇒ User

Parameters:

  • name (String) —

    The name of the option.

Returns:



239
240
241
 
# File 'lib/discordrb/events/interactions.rb', line 239

def options_user(name)
  @resolved[:users][@options[name].to_i]
end

#target ⇒ Message, ...

Returns The target of this command, for context commands.

Returns:

  • (Message, User, nil) —

    The target of this command, for context commands.



231
232
233
234
235
 
# File 'lib/discordrb/events/interactions.rb', line 231

def target
  return nil unless @target_id

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