3.0.0-beta.5

BotCommands-jda-ktx/dev.freya02.botcommands.jda.ktx.retrieve

Package-level declarations

Types

InvalidChannelTypeException

class InvalidChannelTypeException(message: String) : IllegalArgumentException

Exception thrown when retrieving a channel by ID, but the type is incorrect.

Functions

retrieveAutoModRuleByIdOrNull

suspend fun Guild.retrieveAutoModRuleByIdOrNull(id: Long): AutoModRule?

suspend fun Guild.retrieveAutoModRuleByIdOrNull(id: String): AutoModRule?

Same as Guild.retrieveAutoModRuleById, but returns null if the rule does not exist.

retrieveBanOrNull

suspend fun Guild.retrieveBanOrNull(user: UserSnowflake): Guild.Ban?

Retrieves a Ban of the provided UserSnowflake, or null if the user is not banned.

retrieveEmojiByIdOrNull

suspend fun Guild.retrieveEmojiByIdOrNull(id: Long): RichCustomEmoji?

suspend fun Guild.retrieveEmojiByIdOrNull(id: String): RichCustomEmoji?

Same as Guild.retrieveEmojiById, but returns null on ErrorResponse.UNKNOWN_EMOJI.

retrieveEmojiOrNull

suspend fun Guild.retrieveEmojiOrNull(emoji: CustomEmoji): RichCustomEmoji?

Same as Guild.retrieveEmoji, but returns null on ErrorResponse.UNKNOWN_EMOJI.

retrieveEntitlementByIdOrNull

suspend fun JDA.retrieveEntitlementByIdOrNull(entitlementId: Long): Entitlement?

suspend fun JDA.retrieveEntitlementByIdOrNull(entitlementId: String): Entitlement?

Retrieves an Entitlement from the provided ID, see JDA.retrieveEntitlementById for more details.

retrieveMemberByIdOrNull

suspend fun Guild.retrieveMemberByIdOrNull(userId: Long, useCache: Boolean = true): Member?

suspend fun Guild.retrieveMemberByIdOrNull(userId: String, useCache: Boolean = true): Member?

Retrieves a Member with the provided ID.

retrieveMemberOrNull

suspend fun Guild.retrieveMemberOrNull(user: UserSnowflake, useCache: Boolean = true): Member?

Retrieves a Member with the provided User.

retrieveMemberVoiceStateByIdOrNull

suspend fun Guild.retrieveMemberVoiceStateByIdOrNull(id: String): GuildVoiceState?

suspend fun Guild.retrieveMemberVoiceStateByIdOrNull(id: Long, useCache: Boolean = true): GuildVoiceState?

Same as Guild.retrieveMemberVoiceStateById, but returns null on ErrorResponse.UNKNOWN_VOICE_STATE.

retrieveMemberVoiceStateOrNull

suspend fun Guild.retrieveMemberVoiceStateOrNull(user: UserSnowflake): GuildVoiceState?

Same as Guild.retrieveMemberVoiceState, but returns null on ErrorResponse.UNKNOWN_VOICE_STATE.

retrieveMessageByIdOrNull

suspend fun MessageChannel.retrieveMessageByIdOrNull(id: Long): Message?

suspend fun MessageChannel.retrieveMessageByIdOrNull(id: String): Message?

Same as MessageChannel.retrieveMessageById, but returns null on ErrorResponse.UNKNOWN_MESSAGE.

suspend fun WebhookClient<*>.retrieveMessageByIdOrNull(id: String, threadId: String? = null): Message?

Same as WebhookClient.retrieveMessageById, but returns null on ErrorResponse.UNKNOWN_MESSAGE.

retrieveOriginalOrNull

suspend fun InteractionHook.retrieveOriginalOrNull(): Message?

Same as InteractionHook.retrieveOriginal, but returns null on ErrorResponse.UNKNOWN_MESSAGE.

retrieveOwnerOrNull

suspend fun Guild.retrieveOwnerOrNull(useCache: Boolean = true): Member?

Same as Guild.retrieveOwner, but returns null on ErrorResponse.UNKNOWN_MEMBER or ErrorResponse.UNKNOWN_USER.

retrieveParentMessageOrNull

suspend fun ThreadChannel.retrieveParentMessageOrNull(): Message?

Same as ThreadChannel.retrieveParentMessage, but returns null on ErrorResponse.UNKNOWN_MESSAGE.

retrieveScheduledEventByIdOrNull

suspend fun Guild.retrieveScheduledEventByIdOrNull(id: Long, useCache: Boolean = true): ScheduledEvent?

suspend fun Guild.retrieveScheduledEventByIdOrNull(id: String, useCache: Boolean = true): ScheduledEvent?

Same as Guild.retrieveScheduledEventById, but returns null on ErrorResponse.UNKNOWN_SCHEDULED_EVENT.

retrieveStartMessageOrNull

suspend fun ThreadChannel.retrieveStartMessageOrNull(): Message?

Same as ThreadChannel.retrieveStartMessage, but returns null on ErrorResponse.UNKNOWN_MESSAGE.

retrieveStickerOrNull

suspend fun JDA.retrieveStickerOrNull(sticker: StickerSnowflake): StickerUnion?

Retrieves a sticker from the provided ID, see JDA.retrieveSticker for more details.

suspend fun Guild.retrieveStickerOrNull(sticker: StickerSnowflake): GuildSticker?

Same as Guild.retrieveSticker, but returns null on ErrorResponse.UNKNOWN_STICKER.

retrieveThreadChannelById

fun Guild.retrieveThreadChannelById(id: Long): CacheRestAction<ThreadChannel>

fun Guild.retrieveThreadChannelById(id: String): CacheRestAction<ThreadChannel>

Retrieves a thread by ID.

retrieveThreadChannelByIdOrNull

suspend fun Guild.retrieveThreadChannelByIdOrNull(id: Long): ThreadChannel?

suspend fun Guild.retrieveThreadChannelByIdOrNull(id: String): ThreadChannel?

Retrieves a thread by ID.

retrieveThreadChannelOrNull

suspend fun Guild.~~retrieveThreadChannelOrNull~~(id: Long): ThreadChannel?

Retrieves a thread by ID.

retrieveThreadMemberByIdOrNull

suspend fun ThreadChannel.retrieveThreadMemberByIdOrNull(id: Long, useCache: Boolean = true): ThreadMember?

suspend fun ThreadChannel.retrieveThreadMemberByIdOrNull(id: String, useCache: Boolean = true): ThreadMember?

Same as ThreadChannel.retrieveThreadMemberById, but returns null on ErrorResponse.UNKNOWN_MEMBER.

retrieveThreadMemberOrNull

suspend fun ThreadChannel.retrieveThreadMemberOrNull(user: UserSnowflake, useCache: Boolean = true): ThreadMember?

Same as ThreadChannel.retrieveThreadMemberById, but returns null on ErrorResponse.UNKNOWN_MEMBER.

retrieveUserByIdOrNull

suspend fun ShardManager.retrieveUserByIdOrNull(id: Long): User?

suspend fun ShardManager.retrieveUserByIdOrNull(id: String): User?

Same as ShardManager.retrieveUserById, but returns null on ErrorResponse.UNKNOWN_USER.

suspend fun JDA.retrieveUserByIdOrNull(userId: Long, useCache: Boolean = true): User?

suspend fun JDA.retrieveUserByIdOrNull(userId: String, useCache: Boolean = true): User?

Retrieves a User with the provided ID.

retrieveVanityInviteOrNull

suspend fun Guild.retrieveVanityInviteOrNull(): VanityInvite?

Retrieves the Vanity Invite meta-data for this guild, or null if the vanity code is null or when a INVITE_CODE_INVALID error response was caught.

retrieveWebhookByIdOrNull

suspend fun JDA.retrieveWebhookByIdOrNull(webhookId: Long): Webhook?

suspend fun JDA.retrieveWebhookByIdOrNull(webhookId: String): Webhook?

Retrieves a Webhook from the provided ID, see JDA.retrieveWebhookById for more details.

retrieveWelcomeScreenOrNull

suspend fun Guild.retrieveWelcomeScreenOrNull(): GuildWelcomeScreen?

Same as Guild.retrieveWelcomeScreen, but returns null on ErrorResponse.UNKNOWN_GUILD_WELCOME_SCREEN.