EntitySupplier

An abstraction that allows for requesting Discord entities.

Functions

getActiveThreads

abstract fun getActiveThreads(guildId: Snowflake): Flow<ThreadChannel>

getApplicationCommandPermissions

open suspend fun getApplicationCommandPermissions(applicationId: Snowflake, guildId: Snowflake, commandId: Snowflake): ApplicationCommandPermissions

getApplicationCommandPermissionsOrNull

abstract suspend fun getApplicationCommandPermissionsOrNull(applicationId: Snowflake, guildId: Snowflake, commandId: Snowflake): ApplicationCommandPermissions?

getChannel

open suspend fun getChannel(id: Snowflake): Channel

Requests the Channel with the given id.

getChannelOrNull

abstract suspend fun getChannelOrNull(id: Snowflake): Channel?

Requests the Channel with the given id, returns null when the channel isn't present.

getChannelPins

abstract fun getChannelPins(channelId: Snowflake): Flow<Message>

Requests the pinned messages of the Channel with the given channelId.

getChannelWebhooks

abstract fun getChannelWebhooks(channelId: Snowflake): Flow<Webhook>

Requests the webhooks of the MessageChannel with the given channelId.

getCurrentUserGuilds

abstract fun getCurrentUserGuilds(limit: Int = Int.MAX_VALUE): Flow<Guild>

Requests the guild emojis of the Guild with the given guildId.

getEmoji

open suspend fun getEmoji(guildId: Snowflake, emojiId: Snowflake): GuildEmoji

Requests the GuildEmoji with the emojiId in the Guild wit the given guildId.

getEmojiOrNull

abstract suspend fun getEmojiOrNull(guildId: Snowflake, emojiId: Snowflake): GuildEmoji?

Requests the GuildEmoji with the emojiId in the Guild wit the given guildId, returns null when the emoji isn't present.

getEmojis

abstract fun getEmojis(guildId: Snowflake): Flow<GuildEmoji>

Requests the guild emojis of the Guild with the given guildId.

getGlobalApplicationCommand

open suspend fun getGlobalApplicationCommand(applicationId: Snowflake, commandId: Snowflake): GlobalApplicationCommand

getGlobalApplicationCommandOrNull

abstract suspend fun getGlobalApplicationCommandOrNull(applicationId: Snowflake, commandId: Snowflake): GlobalApplicationCommand?

getGlobalApplicationCommands

abstract fun getGlobalApplicationCommands(applicationId: Snowflake): Flow<GlobalApplicationCommand>

getGuild

open suspend fun getGuild(id: Snowflake): Guild

Requests the Guild with the given id.

getGuildApplicationCommand

open suspend fun getGuildApplicationCommand(applicationId: Snowflake, guildId: Snowflake, commandId: Snowflake): GuildApplicationCommand

getGuildApplicationCommandOrNull

abstract suspend fun getGuildApplicationCommandOrNull(applicationId: Snowflake, guildId: Snowflake, commandId: Snowflake): GuildApplicationCommand?

getGuildApplicationCommandPermissions

abstract fun getGuildApplicationCommandPermissions(applicationId: Snowflake, guildId: Snowflake): Flow<ApplicationCommandPermissions>

getGuildApplicationCommands

abstract fun getGuildApplicationCommands(applicationId: Snowflake, guildId: Snowflake): Flow<GuildApplicationCommand>

getGuildBan

open suspend fun getGuildBan(guildId: Snowflake, userId: Snowflake): Ban

Requests the Ban for the user the given userId in the Guild wit the given guildId, returns null when the ban isn't present.

getGuildBanOrNull

abstract suspend fun getGuildBanOrNull(guildId: Snowflake, userId: Snowflake): Ban?

Requests the Ban for the user the given userId in the Guild wit the given guildId, returns null when the ban isn't present.

getGuildBans

abstract fun getGuildBans(guildId: Snowflake): Flow<Ban>

Requests the bans of the Guild with the given guildId.

getGuildChannels

abstract fun getGuildChannels(guildId: Snowflake): Flow<TopGuildChannel>

Requests the channels of the Guild with the given guildId, channels with an Unknown type will be filtered out of the list.

getGuildMembers

abstract fun getGuildMembers(guildId: Snowflake, limit: Int = Int.MAX_VALUE): Flow<Member>

Requests the members of the Guild with the given guildId.

getGuildOrNull

abstract suspend fun getGuildOrNull(id: Snowflake): Guild?

Requests the Guild with the given id, returns null when the guild isn't present.

getGuildPreview

open suspend fun getGuildPreview(guildId: Snowflake): GuildPreview

getGuildPreviewOrNull

abstract suspend fun getGuildPreviewOrNull(guildId: Snowflake): GuildPreview?

getGuildRoles

abstract fun getGuildRoles(guildId: Snowflake): Flow<Role>

Requests the roles of the Guild with the given guildId.

getGuildVoiceRegions

abstract fun getGuildVoiceRegions(guildId: Snowflake): Flow<Region>

Requests the regions of the Guild with the given guildId.

getGuildWebhooks

abstract fun getGuildWebhooks(guildId: Snowflake): Flow<Webhook>

Requests the webhooks of the Guild with the given guildId.

getGuildWidget

open suspend fun getGuildWidget(guildId: Snowflake): GuildWidget

Requests to get the widget of this guildId.

getGuildWidgetOrNull

abstract suspend fun getGuildWidgetOrNull(guildId: Snowflake): GuildWidget?

Requests to get the widget of this guild through the strategy, returns null if the GuildWidget isn't present.

getJoinedPrivateArchivedThreads

abstract fun getJoinedPrivateArchivedThreads(channelId: Snowflake, before: Snowflake, limit: Int): Flow<ThreadChannel>

getMember

open suspend fun getMember(guildId: Snowflake, userId: Snowflake): Member

Requests the Member with the given userId in the Guild wit the given guildId.

getMemberOrNull

abstract suspend fun getMemberOrNull(guildId: Snowflake, userId: Snowflake): Member?

Requests the Member with the given userId in the Guild wit the given guildId, returns null when the member isn't present.

getMessage

open suspend fun getMessage(channelId: Snowflake, messageId: Snowflake): Message

Requests the Message with the given messageId in the MessageChannel with the given channelId.

getMessageOrNull

abstract suspend fun getMessageOrNull(channelId: Snowflake, messageId: Snowflake): Message?

Requests the Message with the given messageId in the MessageChannel with the given channelId, returns null when the message isn't present.

getMessagesAfter

abstract fun getMessagesAfter(messageId: Snowflake, channelId: Snowflake, limit: Int = Int.MAX_VALUE): Flow<Message>

Requests a flow of messages created after the Message with the messageId in the channel with the channelId.

getMessagesAround

abstract fun getMessagesAround(messageId: Snowflake, channelId: Snowflake, limit: Int = 100): Flow<Message>

Requests a flow of messages created around the Message with the messageId in the channel with the channelId.

getMessagesBefore

abstract fun getMessagesBefore(messageId: Snowflake, channelId: Snowflake, limit: Int = Int.MAX_VALUE): Flow<Message>

Requests a flow of messages created before the Message with the messageId in the channel with the channelId.

getPrivateArchivedThreads

abstract fun getPrivateArchivedThreads(channelId: Snowflake, before: Instant, limit: Int): Flow<ThreadChannel>

getPublicArchivedThreads

abstract fun getPublicArchivedThreads(channelId: Snowflake, before: Instant, limit: Int): Flow<ThreadChannel>

getRole

open suspend fun getRole(guildId: Snowflake, roleId: Snowflake): Role

Requests the Role with the given roleId in the Guild wit the given guildId.

getRoleOrNull

abstract suspend fun getRoleOrNull(guildId: Snowflake, roleId: Snowflake): Role?

Requests the Role with the given roleId in the Guild wit the given guildId, returns null when the role isn't present.

getSelf

open suspend fun getSelf(): User

Requests the User this bot represents.

getSelfOrNull

abstract suspend fun getSelfOrNull(): User?

Requests the User this bot represents, returns null when the user isn't present.

getStageInstance

open suspend fun getStageInstance(channelId: Snowflake): StageInstance

getStageInstanceOrNull

abstract suspend fun getStageInstanceOrNull(channelId: Snowflake): StageInstance?

getTemplate

open suspend fun getTemplate(code: String): Template

Requests the Template with the given code.

getTemplateOrNull

abstract suspend fun getTemplateOrNull(code: String): Template?

Requests the Template with the given code.

getTemplates

abstract fun getTemplates(guildId: Snowflake): Flow<Template>

getThreadMembers

abstract fun getThreadMembers(channelId: Snowflake): Flow<ThreadMember>

getUser

open suspend fun getUser(id: Snowflake): User

Requests the User with the given id.

getUserOrNull

abstract suspend fun getUserOrNull(id: Snowflake): User?

Requests the User with the given id, returns null when the user isn't present.

getWebhook

open suspend fun getWebhook(id: Snowflake): Webhook

Requests the Webhook with the given id.

getWebhookOrNull

abstract suspend fun getWebhookOrNull(id: Snowflake): Webhook?

Requests the Webhook with the given id, returns null when the webhook isn't present.

getWebhookWithToken

open suspend fun getWebhookWithToken(id: Snowflake, token: String): Webhook

Requests the Webhook with the given id using the token for authentication.

getWebhookWithTokenOrNull

abstract suspend fun getWebhookWithTokenOrNull(id: Snowflake, token: String): Webhook?

Requests the Webhook with the given id using the token for authentication, returns null when the webhook isn't present.

Properties

guilds

abstract val guilds: Flow<Guild>

Requests all guilds this bot is known to be part of.

regions

abstract val regions: Flow<Region>

Requests all regions known to this bot.

Inheritors

StoreEntitySupplier

CacheEntitySupplier

RestEntitySupplier

Extensions

getChannelOf

inline suspend fun <T : Channel> EntitySupplier.getChannelOf(id: Snowflake): T

Requests the Channel with the given id as type T.

getChannelOfOrNull

inline suspend fun <T : Channel> EntitySupplier.getChannelOfOrNull(id: Snowflake): T?

Requests the Channel with the given id as type T, returns null if the channel isn't present or if the channel is not of type T.

getGlobalApplicationCommandOf

inline suspend fun <T : GlobalApplicationCommand> EntitySupplier.getGlobalApplicationCommandOf(applicationId: Snowflake, id: Snowflake): T

Requests the GlobalApplicationCommand with the given id as type T.

getGlobalApplicationCommandOfOrNull

inline suspend fun <T : GlobalApplicationCommand> EntitySupplier.getGlobalApplicationCommandOfOrNull(applicationId: Snowflake, id: Snowflake): T?

Requests the GuildApplicationCommand with the given id as type T, returns null if the command application isn't present or if the channel is not of type T.

getGlobalApplicationOf

inline suspend fun <T : GlobalApplicationCommand> EntitySupplier.getGlobalApplicationOf(applicationId: Snowflake, id: Snowflake): T

Requests the GlobalApplicationCommand with the given id as type T.

getGlobalApplicationOfOrNull

inline suspend fun <T : GlobalApplicationCommand> EntitySupplier.getGlobalApplicationOfOrNull(applicationId: Snowflake, id: Snowflake): T?

Requests the GlobalApplicationCommand with the given id as type T, returns null if the command application isn't present or if the channel is not of type T.

getGuildApplicationCommandOf

inline suspend fun <T : GuildApplicationCommand> EntitySupplier.getGuildApplicationCommandOf(applicationId: Snowflake, guildId: Snowflake, id: Snowflake): T

Requests the GuildApplicationCommand with the given id as type T.

getGuildApplicationCommandOfOrNull

inline suspend fun <T : GuildApplicationCommand> EntitySupplier.getGuildApplicationCommandOfOrNull(applicationId: Snowflake, guildId: Snowflake, id: Snowflake): T?

Requests the GuildApplicationCommand with the given id as type T, returns null if the command application isn't present or if the channel is not of type T.

withFallback

infix fun EntitySupplier.withFallback(other: EntitySupplier): EntitySupplier

Creates supplier providing a strategy which will first operate on this supplier.

Sources

jvm source