BotCommands/io.github.freya022.botcommands.api.localization.interaction

Package-level declarations

Types

@InterfacedService(acceptMultiple = false)

Provides the locale of a guild in a Discord interaction, may be useful if the guild has set its own locale, for example.

LocalizableEditCallback

interface LocalizableEditCallback

Allows editing an interaction's original message using localized strings, registered from bundles in BLocalizationConfig.responseBundles.

LocalizableInteraction

interface LocalizableInteraction : LocalizableAction

Allows you to configure the localization settings of this interaction event, retrieve a LocalizableInteractionHook, as well as retrieve a localization context from it.

LocalizableInteractionHook

interface LocalizableInteractionHook : InteractionHook

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

LocalizableReplyCallback

interface LocalizableReplyCallback

Allows replying to interactions using localized strings, registered from bundles in BLocalizationConfig.responseBundles.

UserLocaleProvider

@InterfacedService(acceptMultiple = false)

interface UserLocaleProvider

Provides the locale of a user in a Discord interaction, may be useful if the user has set its own locale, for example.

Functions

editGuild

fun LocalizableEditCallback.editGuild(localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

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

editLocalized

fun LocalizableEditCallback.editLocalized(locale: Locale, localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

fun LocalizableEditCallback.editLocalized(locale: DiscordLocale, localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

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

editUser

fun LocalizableEditCallback.editUser(localizationPath: String, vararg entries: PairEntry): MessageEditCallbackAction

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

getGuildMessage

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

getUserMessage

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

replyGuild

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

replyLocalized

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

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

replyUser

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

sendGuild

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

sendLocalized

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

sendUser

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