BotCommands-core/io.github.freya022.botcommands.api.localization.interaction/LocalizableInteractionHook

LocalizableInteractionHook

interface LocalizableInteractionHook : InteractionHook(source)

Allows sending follow-ups to interactions using localized strings, registered from bundles in BLocalizationConfig.responseBundles.

See LocalizableInteraction for further configuration.

Properties

callbackResponse

@get:Nonnull

abstract val callbackResponse: InteractionCallbackResponse

expirationTimestamp

abstract val expirationTimestamp: Long

@get:Nonnull

open val id: String

idLong

abstract val idLong: Long

interaction

@get:Nonnull

abstract val interaction: Interaction

isExpired

open val isExpired: Boolean

jda

@get:Nonnull

abstract val jda: JDA

localizableInteraction

abstract val localizableInteraction: LocalizableInteraction

The localizable interaction attached to this hook.

timeCreated

@get:Nonnull

open val timeCreated: OffsetDateTime

token

@get:Nullable

abstract override val token: String?

Functions

deleteMessageById

@Nonnull

@CheckReturnValue

open fun deleteMessageById(messageId: Long): WebhookMessageDeleteAction

@Nonnull

@CheckReturnValue

abstract fun deleteMessageById(@Nonnull p0: String): WebhookMessageDeleteAction

deleteOriginal

@Nonnull

@CheckReturnValue

open fun deleteOriginal(): RestAction<Void?>

editGuild

@CheckReturnValue

abstract fun editGuild(localizationPath: String, vararg entries: Localization.Entry): WebhookMessageEditAction<Message>

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

editGuild

fun LocalizableInteractionHook.editGuild(localizationPath: String, vararg entries: PairEntry): WebhookMessageEditAction<Message>

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

editLocalized

@CheckReturnValue

abstract fun editLocalized(locale: Locale, localizationPath: String, vararg entries: Localization.Entry): WebhookMessageEditAction<Message>

@CheckReturnValue

open fun editLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: Localization.Entry): WebhookMessageEditAction<Message>

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

editLocalized

fun InteractionHook.editLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): WebhookMessageEditAction<Message>

Edits the text content of the original message with a localized message.

fun LocalizableInteractionHook.editLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): WebhookMessageEditAction<Message>

fun LocalizableInteractionHook.editLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): WebhookMessageEditAction<Message>

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

editMessageAttachmentsById

@Nonnull

@CheckReturnValue

open fun editMessageAttachmentsById(messageId: Long, @Nonnull attachments: Collection<out AttachedFile?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageAttachmentsById(messageId: Long, @Nonnull vararg attachments: AttachedFile?): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

abstract fun editMessageAttachmentsById(@Nonnull p0: String, @Nonnull p1: Collection<out AttachedFile?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageAttachmentsById(@Nonnull messageId: String, @Nonnull vararg attachments: AttachedFile?): WebhookMessageEditAction<Message?>

editMessageById

@Nonnull

@CheckReturnValue

open fun editMessageById(messageId: Long, @Nonnull content: String): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageById(messageId: Long, @Nonnull message: MessageEditData): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

abstract fun editMessageById(@Nonnull p0: String, @Nonnull p1: String): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

abstract fun editMessageById(@Nonnull p0: String, @Nonnull p1: MessageEditData): WebhookMessageEditAction<Message?>

editMessageComponentsById

@Nonnull

@CheckReturnValue

open fun editMessageComponentsById(messageId: Long, @Nonnull components: Collection<out MessageTopLevelComponent?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageComponentsById(messageId: Long, @Nonnull vararg components: MessageTopLevelComponent?): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageComponentsById(messageId: Long, @Nonnull tree: ComponentTree<out MessageTopLevelComponent?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

abstract fun editMessageComponentsById(@Nonnull p0: String, @Nonnull p1: Collection<out MessageTopLevelComponent?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageComponentsById(@Nonnull messageId: String, @Nonnull vararg components: MessageTopLevelComponent?): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageComponentsById(@Nonnull messageId: String, @Nonnull tree: ComponentTree<out MessageTopLevelComponent?>): WebhookMessageEditAction<Message?>

editMessageEmbedsById

@Nonnull

@CheckReturnValue

open fun editMessageEmbedsById(messageId: Long, @Nonnull embeds: Collection<out MessageEmbed?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageEmbedsById(messageId: Long, @Nonnull vararg embeds: MessageEmbed?): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

abstract fun editMessageEmbedsById(@Nonnull p0: String, @Nonnull p1: Collection<out MessageEmbed?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageEmbedsById(@Nonnull messageId: String, @Nonnull vararg embeds: MessageEmbed?): WebhookMessageEditAction<Message?>

editMessageFormatById

@Nonnull

@CheckReturnValue

open fun editMessageFormatById(messageId: Long, @Nonnull format: String, @Nonnull vararg args: Any?): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editMessageFormatById(@Nonnull messageId: String, @Nonnull format: String, @Nonnull vararg args: Any?): WebhookMessageEditAction<Message?>

editOriginal

@Nonnull

@CheckReturnValue

open fun editOriginal(@Nonnull content: String): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editOriginal(@Nonnull message: MessageEditData): WebhookMessageEditAction<Message?>

editOriginalAttachments

@Nonnull

@CheckReturnValue

open fun editOriginalAttachments(@Nonnull attachments: Collection<out AttachedFile?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editOriginalAttachments(@Nonnull vararg attachments: AttachedFile?): WebhookMessageEditAction<Message?>

editOriginalComponents

@Nonnull

@CheckReturnValue

open fun editOriginalComponents(@Nonnull components: Collection<out MessageTopLevelComponent?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editOriginalComponents(@Nonnull vararg components: MessageTopLevelComponent?): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editOriginalComponents(@Nonnull tree: ComponentTree<out MessageTopLevelComponent?>): WebhookMessageEditAction<Message?>

editOriginalEmbeds

@Nonnull

@CheckReturnValue

open fun editOriginalEmbeds(@Nonnull embeds: Collection<out MessageEmbed?>): WebhookMessageEditAction<Message?>

@Nonnull

@CheckReturnValue

open fun editOriginalEmbeds(@Nonnull vararg embeds: MessageEmbed?): WebhookMessageEditAction<Message?>

editOriginalFormat

@Nonnull

@CheckReturnValue

open fun editOriginalFormat(@Nonnull format: String, @Nonnull vararg args: Any?): WebhookMessageEditAction<Message?>

editUser

@CheckReturnValue

abstract fun editUser(localizationPath: String, vararg entries: Localization.Entry): WebhookMessageEditAction<Message>

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

editUser

fun LocalizableInteractionHook.editUser(localizationPath: String, vararg entries: PairEntry): WebhookMessageEditAction<Message>

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

hasCallbackResponse

abstract fun hasCallbackResponse(): Boolean

replaceLocalized

fun InteractionHook.replaceLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): WebhookMessageEditAction<Message>

Replaces the entire original message with a localized message.

retrieveMessageById

@Nonnull

@CheckReturnValue

abstract fun retrieveMessageById(@Nonnull p0: String): WebhookMessageRetrieveAction

retrieveOriginal

@Nonnull

@CheckReturnValue

open fun retrieveOriginal(): RestAction<Message?>

sendFiles

@Nonnull

@CheckReturnValue

abstract fun sendFiles(@Nonnull p0: Collection<out FileUpload?>): WebhookMessageCreateAction<Message?>

@Nonnull

@CheckReturnValue

open fun sendFiles(@Nonnull vararg files: FileUpload?): WebhookMessageCreateAction<Message?>

sendGuild

@CheckReturnValue

abstract fun sendGuild(localizationPath: String, vararg entries: Localization.Entry): WebhookMessageCreateAction<Message>

Sends a follow-up with the localized message at the following path, using the guild's locale and provided parameters.

sendGuild

fun LocalizableInteractionHook.sendGuild(localizationPath: String, vararg entries: PairEntry): WebhookMessageCreateAction<Message>

Sends a follow-up with the localized message at the following path, using the guild's locale and provided parameters.

sendLocalized

@CheckReturnValue

abstract fun sendLocalized(locale: Locale, localizationPath: String, vararg entries: Localization.Entry): WebhookMessageCreateAction<Message>

@CheckReturnValue

open fun sendLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: Localization.Entry): WebhookMessageCreateAction<Message>

Sends a follow-up with the localized message at the following path, using the provided locale and parameters.

sendLocalized

fun InteractionHook.sendLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): WebhookMessageCreateAction<Message>

Sends a localized followup message to this interaction hook.

fun LocalizableInteractionHook.sendLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): WebhookMessageCreateAction<Message>

fun LocalizableInteractionHook.sendLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): WebhookMessageCreateAction<Message>

Sends a follow-up with the localized message at the following path, using the provided locale and parameters.

sendLocalizedEphemeral

fun InteractionHook.sendLocalizedEphemeral(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): WebhookMessageCreateAction<Message>

Sends a localized ephemeral followup message to this interaction hook.

sendMessage

@Nonnull

@CheckReturnValue

abstract fun sendMessage(@Nonnull p0: String): WebhookMessageCreateAction<Message?>

@Nonnull

@CheckReturnValue

abstract fun sendMessage(@Nonnull p0: MessageCreateData): WebhookMessageCreateAction<Message?>

sendMessageComponents

@Nonnull

@CheckReturnValue

abstract fun sendMessageComponents(@Nonnull p0: Collection<out MessageTopLevelComponent?>): WebhookMessageCreateAction<Message?>

@Nonnull

@CheckReturnValue

open fun sendMessageComponents(@Nonnull tree: ComponentTree<out MessageTopLevelComponent?>): WebhookMessageCreateAction<Message?>

@Nonnull

@CheckReturnValue

open fun sendMessageComponents(@Nonnull component: MessageTopLevelComponent, @Nonnull vararg other: MessageTopLevelComponent?): WebhookMessageCreateAction<Message?>

sendMessageEmbeds

@Nonnull

@CheckReturnValue

abstract fun sendMessageEmbeds(@Nonnull p0: Collection<out MessageEmbed?>): WebhookMessageCreateAction<Message?>

@Nonnull

@CheckReturnValue

open fun sendMessageEmbeds(@Nonnull embed: MessageEmbed, @Nonnull vararg embeds: MessageEmbed?): WebhookMessageCreateAction<Message?>

sendMessageFormat

@Nonnull

@CheckReturnValue

open fun sendMessageFormat(@Nonnull format: String, @Nonnull vararg args: Any?): WebhookMessageCreateAction<Message?>

sendMessagePoll

@Nonnull

@CheckReturnValue

abstract fun sendMessagePoll(@Nonnull p0: MessagePollData): WebhookMessageCreateAction<Message?>

sendUser

@CheckReturnValue

abstract fun sendUser(localizationPath: String, vararg entries: Localization.Entry): WebhookMessageCreateAction<Message>

Sends a follow-up with the localized message at the following path, using the user's locale and provided parameters.

sendUser

fun LocalizableInteractionHook.sendUser(localizationPath: String, vararg entries: PairEntry): WebhookMessageCreateAction<Message>

Sends a follow-up with the localized message at the following path, using the user's locale and provided parameters.

setEphemeral

@Nonnull

abstract fun setEphemeral(p0: Boolean): InteractionHook

LocalizableInteractionHook

See also

Properties

Functions