BotCommands-core/io.github.freya022.botcommands.api.commands.application.context.user/GlobalUserEvent

GlobalUserEvent

open class GlobalUserEvent : UserContextInteractionEvent, CancellableRateLimit, LocalizableInteraction, LocalizableReplyCallback(source)

Interaction event for global user context commands.

Localization

You can send localized replies using the user, guild and also any Locale, by using this event directly, but also the interaction hook, see LocalizableInteraction for more details and configuration.

An alternative to using this event is injecting an AppLocalizationContext in a parameter, or retrieving one using getLocalizationContext.

In both cases, you can configure the user and guild locales, using UserLocaleProvider and GuildLocaleProvider.

Rate limit cancellation

Although it is recommended to reject commands using ApplicationCommandFilter, you can also return the bucket token with cancelRateLimit if you want to avoid consuming bandwidth in certain conditions.

Inheritors

GuildUserEvent

Properties

channel

@get:Nullable

open override val channel: Channel?

channelId

@get:Nullable

open val channelId: String?

channelIdLong

open override val channelIdLong: Long

channelType

@get:Nonnull

open val channelType: ChannelType

commandId

@get:Nonnull

open val commandId: String

commandIdLong

open override val commandIdLong: Long

commandString

@get:Nonnull

open val commandString: String

commandType

@get:Nonnull

open override val commandType: Command.Type

context

val context: BContext

@get:Nonnull

open override val context: InteractionContextType

entitlements

@get:Nonnull

open override val entitlements: List<Entitlement?>

fullCommandName

@get:Nonnull

open val fullCommandName: String

guild

@get:Nullable

open override val guild: Guild?

guildChannel

@get:Nonnull

open val guildChannel: GuildChannel

guildLocale

@get:Nonnull

open override val guildLocale: DiscordLocale

hook

open override val hook: LocalizableInteractionHook

@get:Nonnull

open val id: String

idLong

open override val idLong: Long

inputUser

val Interaction.inputUser: InputUser

Gets the interaction user as an InputUser.

integrationOwners

@get:Nonnull

open override val integrationOwners: IntegrationOwners

interaction

@get:Nonnull

open val interaction: UserContextInteraction

isAcknowledged

open override val isAcknowledged: Boolean

isFromAttachedGuild

open val isFromAttachedGuild: Boolean

isFromGuild

open val isFromGuild: Boolean

isGlobalCommand

open val isGlobalCommand: Boolean

isGuildCommand

open override val isGuildCommand: Boolean

isRateLimitCancelled

open override val isRateLimitCancelled: Boolean

jda

@get:Nonnull

open override val jda: JDA

localizationBundle

open override var localizationBundle: String?

If set, forces the specified localization bundle to be used.

localizationPrefix

open override var localizationPrefix: String?

If set, adds the specified prefix to the path of every localization call, useful to avoid using very long strings in every reply/edit.

member

@get:Nullable

open override val member: Member?

messageChannel

@get:Nonnull

open val messageChannel: MessageChannel

name

@get:Nonnull

open override val name: String

options

@get:Nonnull

open override val options: List<OptionMapping?>

rawData

open override val rawData: DataObject?

responseNumber

open val responseNumber: Long

subcommandGroup

@get:Nullable

open override val subcommandGroup: String?

subcommandName

@get:Nullable

open override val subcommandName: String?

target

@get:Nonnull

open override val target: User

targetMember

@get:Nullable

open val targetMember: Member?

targetType

@get:Nonnull

open override val targetType: ContextInteraction.ContextTarget

timeCreated

@get:Nonnull

open val timeCreated: OffsetDateTime

token

@get:Nonnull

open override val token: String

type

@get:Nonnull

open val type: InteractionType

typeRaw

open override val typeRaw: Int

user

@get:Nonnull

open override val user: User

userLocale

@get:Nonnull

open override val userLocale: DiscordLocale

Functions

cancelRateLimit

open override fun cancelRateLimit()

Cancels the token consumption of the current rate limited interaction.

deferReply

@Nonnull

@CheckReturnValue

open fun deferReply(): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun deferReply(ephemeral: Boolean): ReplyCallbackAction

getBotCommandsMessages

open override fun getBotCommandsMessages(): BotCommandsMessages

Retrieves a BotCommandsMessages instance, using a locale suitable for messages sent to the user.

getChannel

@Nullable

open fun getChannel(): Channel?

getChannelIdLong

open fun getChannelIdLong(): Long

getCommandIdLong

open fun getCommandIdLong(): Long

getCommandType

@Nonnull

open fun getCommandType(): Command.Type

getContext

@Nonnull

open fun getContext(): InteractionContextType

getDefaultMessages

open override fun ~~getDefaultMessages~~(): DefaultMessages

Retrieves a DefaultMessages instance, using a locale suitable for messages sent to the user.

getEntitlements

@Nonnull

open fun getEntitlements(): List<Entitlement?>

getGuild

@Nullable

open fun getGuild(): Guild?

getGuildLocale

@Nonnull

open fun getGuildLocale(): DiscordLocale

getGuildMessage

open override fun getGuildMessage(localizationPath: String, vararg entries: Localization.Entry): String

Returns the localized message at the following path, using the guild's locale and parameters.

getGuildMessage

fun LocalizableInteraction.getGuildMessage(localizationPath: String, vararg entries: PairEntry): String

Returns the localized message at the following path, using the guild's locale and parameters.

getHook

open override fun getHook(): LocalizableInteractionHook

getIdLong

open fun getIdLong(): Long

getIntegrationOwners

@Nonnull

open fun getIntegrationOwners(): IntegrationOwners

getJDA

@Nonnull

open fun getJDA(): JDA

getLocalizationContext

open override fun getLocalizationContext(bundleName: String, pathPrefix: String?): AppLocalizationContext

Returns a localization context for the provided bundle name and path prefix, using the locales from UserLocaleProvider.getDiscordLocale and GuildLocaleProvider.getDiscordLocale.

getLocalizedMessage

open override fun getLocalizedMessage(locale: Locale, localizationPath: String, vararg entries: Localization.Entry): String

open override fun getLocalizedMessage(locale: DiscordLocale, localizationPath: String, vararg entries: Localization.Entry): String

Returns the localized message at the following path, using the provided locale and parameters.

getLocalizedMessage

fun LocalizableAction.getLocalizedMessage(locale: Locale, localizationPath: String, vararg entries: PairEntry): String

fun LocalizableAction.getLocalizedMessage(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): String

getMember

@Nullable

open fun getMember(): Member?

getName

@Nonnull

open fun getName(): String

getOption

@Nullable

open fun getOption(@Nonnull name: String): OptionMapping?

@Nullable

open fun <T : Any?> getOption(@Nonnull name: String, @Nonnull resolver: Function<in OptionMapping?, out T?>): T?

@Contract(value = "_,null,_->null")

open fun <T : Any?> getOption(@Nonnull name: String, @Nullable fallback: T?, @Nonnull resolver: Function<in OptionMapping?, out T?>): T?

@UnknownNullability

open fun <T : Any?> getOption(@Nonnull name: String, @Nullable fallback: Supplier<out T?>?, @Nonnull resolver: Function<in OptionMapping?, out T?>): T?

getOptions

@Nonnull

open fun getOptions(): List<OptionMapping?>

getOptionsByName

@Nonnull

open fun getOptionsByName(@Nonnull name: String): List<OptionMapping?>

getOptionsByType

@Nonnull

open fun getOptionsByType(@Nonnull type: OptionType): List<OptionMapping?>

getRawData

open override fun getRawData(): DataObject?

getSubcommandGroup

@Nullable

open fun getSubcommandGroup(): String?

getSubcommandName

@Nullable

open fun getSubcommandName(): String?

getTarget

@Nonnull

open fun getTarget(): User

getTargetType

@Nonnull

open fun getTargetType(): ContextInteraction.ContextTarget

getToken

@Nonnull

open fun getToken(): String

getTypeRaw

open fun getTypeRaw(): Int

getUser

@Nonnull

open fun getUser(): User

getUserLocale

@Nonnull

open fun getUserLocale(): DiscordLocale

getUserMessage

open override fun getUserMessage(localizationPath: String, vararg entries: Localization.Entry): String

Returns the localized message at the following path, using the user's locale and parameters.

getUserMessage

fun LocalizableInteraction.getUserMessage(localizationPath: String, vararg entries: PairEntry): String

Returns the localized message at the following path, using the user's locale and parameters.

isAcknowledged

open fun isAcknowledged(): Boolean

isGuildCommand

open fun isGuildCommand(): Boolean

@Nonnull

@CheckReturnValue

open fun reply(@Nonnull content: String): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun reply(@Nonnull message: MessageCreateData): ReplyCallbackAction

replyComponents

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull components: Collection<out MessageTopLevelComponent?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull tree: ComponentTree<out MessageTopLevelComponent?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyComponents(@Nonnull component: MessageTopLevelComponent, @Nonnull vararg other: MessageTopLevelComponent?): ReplyCallbackAction

replyEmbeds

@Nonnull

@CheckReturnValue

open fun replyEmbeds(@Nonnull embeds: Collection<out MessageEmbed?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyEmbeds(@Nonnull embed: MessageEmbed, @Nonnull vararg embeds: MessageEmbed?): ReplyCallbackAction

replyFiles

@Nonnull

@CheckReturnValue

open fun replyFiles(@Nonnull files: Collection<out FileUpload?>): ReplyCallbackAction

@Nonnull

@CheckReturnValue

open fun replyFiles(@Nonnull vararg files: FileUpload?): ReplyCallbackAction

replyFormat

@Nonnull

@CheckReturnValue

open fun replyFormat(@Nonnull format: String, @Nonnull vararg args: Any?): ReplyCallbackAction

replyGuild

@CheckReturnValue

open override fun replyGuild(localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

Replies with the localized message at the following path, using the guild's locale and provided parameters.

replyGuild

fun LocalizableReplyCallback.replyGuild(localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies with the localized message at the following path, using the guild's locale and provided parameters.

replyLocalized

@CheckReturnValue

open override fun replyLocalized(locale: Locale, localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

@CheckReturnValue

open override fun replyLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

Replies with the localized message at the following path, using the provided locale and parameters.

replyLocalized

fun IReplyCallback.replyLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies a localized message to this interaction and acknowledges it.

fun LocalizableReplyCallback.replyLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

fun LocalizableReplyCallback.replyLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies with the localized message at the following path, using the provided locale and parameters.

replyLocalizedEphemeral

fun IReplyCallback.replyLocalizedEphemeral(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies a localized ephemeral message to this interaction and acknowledges it.

replyModal

@Nonnull

@CheckReturnValue

open fun replyModal(@Nonnull modal: Modal): ModalCallbackAction

replyPoll

@Nonnull

@CheckReturnValue

open fun replyPoll(@Nonnull poll: MessagePollData): ReplyCallbackAction

replyUser

@CheckReturnValue

open override fun replyUser(localizationPath: String, vararg entries: Localization.Entry): ReplyCallbackAction

Replies with the localized message at the following path, using the user's locale and provided parameters.

replyUser

fun LocalizableReplyCallback.replyUser(localizationPath: String, vararg entries: PairEntry): ReplyCallbackAction

Replies with the localized message at the following path, using the user's locale and provided parameters.

GlobalUserEvent

Localization

Rate limit cancellation

See also

Inheritors

Properties

Functions