BotCommands/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.

See also

Properties

Link copied to clipboard
abstract val localizableInteraction: LocalizableInteraction

The localizable interaction attached to this hook.

Functions

Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun deleteMessageById(p0: Long): WebhookMessageDeleteAction
@Nonnull
@CheckReturnValue
abstract fun deleteMessageById(@Nonnull p0: String): WebhookMessageDeleteAction
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun deleteOriginal(): RestAction<Void>
Link copied to clipboard
@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.

Link copied to clipboard
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.

Link copied to clipboard
@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.

Link copied to clipboard
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.

Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editMessageAttachmentsById(p0: Long, @Nonnull vararg p1: AttachedFile): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageAttachmentsById(p0: Long, @Nonnull p1: MutableCollection<out AttachedFile>): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageAttachmentsById(@Nonnull p0: String, @Nonnull vararg p1: AttachedFile): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
abstract fun editMessageAttachmentsById(@Nonnull p0: String, @Nonnull p1: MutableCollection<out AttachedFile>): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editMessageById(p0: Long, @Nonnull p1: String): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageById(p0: Long, p1: 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>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editMessageComponentsById(p0: Long, @Nonnull vararg p1: LayoutComponent): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageComponentsById(p0: Long, @Nonnull p1: MutableCollection<out LayoutComponent>): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageComponentsById(@Nonnull p0: String, @Nonnull vararg p1: LayoutComponent): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
abstract fun editMessageComponentsById(@Nonnull p0: String, @Nonnull p1: MutableCollection<out LayoutComponent>): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editMessageEmbedsById(p0: Long, @Nonnull vararg p1: MessageEmbed): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageEmbedsById(p0: Long, @Nonnull p1: MutableCollection<out MessageEmbed>): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageEmbedsById(@Nonnull p0: String, @Nonnull vararg p1: MessageEmbed): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
abstract fun editMessageEmbedsById(@Nonnull p0: String, @Nonnull p1: MutableCollection<out MessageEmbed>): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editMessageFormatById(p0: Long, @Nonnull p1: String, @Nonnull vararg p2: Any): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editMessageFormatById(@Nonnull p0: String, @Nonnull p1: String, @Nonnull vararg p2: Any): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editOriginal(@Nonnull p0: String): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editOriginal(@Nonnull p0: MessageEditData): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editOriginalAttachments(@Nonnull vararg p0: AttachedFile): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editOriginalAttachments(@Nonnull p0: MutableCollection<out AttachedFile>): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editOriginalComponents(@Nonnull vararg p0: LayoutComponent): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editOriginalComponents(@Nonnull p0: MutableCollection<out LayoutComponent>): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editOriginalEmbeds(@Nonnull vararg p0: MessageEmbed): WebhookMessageEditAction<Message>
@Nonnull
@CheckReturnValue
open fun editOriginalEmbeds(@Nonnull p0: MutableCollection<out MessageEmbed>): WebhookMessageEditAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun editOriginalFormat(@Nonnull p0: String, @Nonnull vararg p1: Any): WebhookMessageEditAction<Message>
Link copied to clipboard
@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.

Link copied to clipboard
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.

Link copied to clipboard
abstract fun getExpirationTimestamp(): Long
Link copied to clipboard
@Nonnull
open fun getId(): String
Link copied to clipboard
abstract fun getIdLong(): Long
Link copied to clipboard
@Nonnull
abstract fun getInteraction(): Interaction
Link copied to clipboard
@Nonnull
abstract override fun getJDA(): JDA
Link copied to clipboard
@Nonnull
open fun getTimeCreated(): OffsetDateTime
Link copied to clipboard
@Nullable
abstract fun getToken(): String?
Link copied to clipboard
open fun isExpired(): Boolean
Link copied to clipboard
fun InteractionHook.replaceLocalized(context: LocalizationContext, localizationPath: String, vararg entries: PairEntry): WebhookMessageEditAction<Message>

Replaces the entire original message with a localized message.

Link copied to clipboard
Link copied to clipboard
@Nonnull
@CheckReturnValue
abstract fun retrieveMessageById(@Nonnull p0: String): WebhookMessageRetrieveAction
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun retrieveOriginal(): RestAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun sendFiles(@Nonnull vararg p0: FileUpload): WebhookMessageCreateAction<Message>
@Nonnull
@CheckReturnValue
abstract fun sendFiles(@Nonnull p0: MutableCollection<out FileUpload>): WebhookMessageCreateAction<Message>
Link copied to clipboard
@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.

Link copied to clipboard
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.

Link copied to clipboard
@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.

Link copied to clipboard
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.

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

Sends a localized ephemeral followup message to this interaction hook.

Link copied to clipboard
@Nonnull
@CheckReturnValue
abstract fun sendMessage(@Nonnull p0: String): WebhookMessageCreateAction<Message>
@Nonnull
@CheckReturnValue
abstract fun sendMessage(@Nonnull p0: MessageCreateData): WebhookMessageCreateAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
abstract fun sendMessageComponents(@Nonnull p0: MutableCollection<out LayoutComponent>): WebhookMessageCreateAction<Message>
@Nonnull
@CheckReturnValue
open fun sendMessageComponents(@Nonnull p0: LayoutComponent, @Nonnull vararg p1: LayoutComponent): WebhookMessageCreateAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
abstract fun sendMessageEmbeds(@Nonnull p0: MutableCollection<out MessageEmbed>): WebhookMessageCreateAction<Message>
@Nonnull
@CheckReturnValue
open fun sendMessageEmbeds(@Nonnull p0: MessageEmbed, @Nonnull vararg p1: MessageEmbed): WebhookMessageCreateAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
open fun sendMessageFormat(@Nonnull p0: String, @Nonnull vararg p1: Any): WebhookMessageCreateAction<Message>
Link copied to clipboard
@Nonnull
@CheckReturnValue
abstract fun sendMessagePoll(@Nonnull p0: MessagePollData): WebhookMessageCreateAction<Message>
Link copied to clipboard
@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.

Link copied to clipboard
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.

Link copied to clipboard
@Nonnull
abstract fun setEphemeral(p0: Boolean): InteractionHook