BotCommands-jda-ktx/io.github.freya022.botcommands.api.core.utils

Package-level declarations

Types

InvalidChannelTypeException

typealias InvalidChannelTypeException = dev.freya02.botcommands.jda.ktx.retrieve.InvalidChannelTypeException

RestResult

typealias RestResult<T> = dev.freya02.botcommands.jda.ktx.requests.RestResult<T>

Functions

after

fun TimeFormat.~~after~~(duration: Duration): Timestamp

awaitCatching

suspend fun <R> RestAction<R>.~~awaitCatching~~(): RestResult<R>

Awaits the completion of this RestAction and wraps it in a Result.

awaitNull

suspend fun <R> RestAction<*>.~~awaitNull~~(): R?

Awaits the completion of this RestAction and returns null.

awaitOrNullOn

suspend fun <R> RestAction<R>.~~awaitOrNullOn~~(ignored: ErrorResponse, vararg errorResponses: ErrorResponse): R?

Awaits the completion of this RestAction, returns null if one of the provided error responses was thrown.

awaitShutdown

fun JDA.~~awaitShutdown~~(timeout: Duration): Boolean

awaitUnit

suspend fun RestAction<*>.~~awaitUnit~~()

Awaits the completion of this RestAction.

ban

fun Member.~~ban~~(deletionTimeframe: Duration): AuditableRestAction<Void>

fun Guild.~~ban~~(user: UserSnowflake, deletionTimeframe: Duration): AuditableRestAction<Void>

fun Guild.~~ban~~(users: Collection<UserSnowflake>, duration: Duration): AuditableRestAction<BulkBanResponse>

See bulk ban from JDA

before

fun TimeFormat.~~before~~(duration: Duration): Timestamp

delay

fun <T> RestAction<T>.~~delay~~(duration: Duration): RestAction<T>

fun <T> RestAction<T>.~~delay~~(duration: Duration, scheduler: ScheduledExecutorService): RestAction<T>

deleteDelayed

@JvmName(name = "deleteDelayedMessage")

fun RestAction<Message>.~~deleteDelayed~~(delay: Duration?): RestAction<Message>

Deletes the message after the specified delay.

fun RestAction<InteractionHook>.~~deleteDelayed~~(delay: Duration?): RestAction<InteractionHook>

fun <R> RestAction<R>.~~deleteDelayed~~(hook: InteractionHook, delay: Duration?): RestAction<R>

Deletes the original message using the hook after the specified delay.

edit

fun MessageEditData.~~edit~~(hook: InteractionHook): WebhookMessageEditAction<Message>

fun MessageEditData.~~edit~~(callback: IMessageEditCallback): MessageEditCallbackAction

fun MessageEditData.~~edit~~(channel: MessageChannel, id: Long): MessageEditAction

handle

inline fun <T> RestResult<T>.~~handle~~(predicate: (Throwable) -> Boolean, block: (Throwable) -> Unit): RestResult<T>

Dismisses the encapsulated exception and runs the given block if it matches the predicate.

inline fun <T> RestResult<T>.~~handle~~(type: KClass<out Throwable>, vararg types: KClass<out Throwable>, block: (Throwable) -> Unit): RestResult<T>

Dismisses the encapsulated exception and runs the given block if it corresponds to an ignored exception type.

inline fun <T> RestResult<T>.~~handle~~(type: ErrorResponse, vararg responses: ErrorResponse, block: (ErrorResponseException) -> Unit): RestResult<T>

Dismisses the encapsulated exception and runs the given block if it corresponds to an ignored response.

ignore

inline fun <T> RestResult<T>.~~ignore~~(predicate: (Throwable) -> Boolean): RestResult<T>

Dismisses the encapsulated exception if it corresponds to the predicate.

fun <T> RestResult<T>.~~ignore~~(ignored: KClass<out Throwable>, vararg types: KClass<out Throwable>): RestResult<T>

Dismisses the encapsulated exception if it corresponds to an ignored exception.

fun <T> RestResult<T>.~~ignore~~(ignored: ErrorResponse, vararg responses: ErrorResponse): RestResult<T>

Dismisses the encapsulated error response if it corresponds to an ignored response.

minus

operator fun Timestamp.~~minus~~(duration: Duration): Timestamp

onErrorResponse

inline fun <T> RestResult<T>.~~onErrorResponse~~(block: (ErrorResponse) -> Unit): RestResult<T>

Runs the given block if the result is an error response.

inline fun <T> RestResult<T>.~~onErrorResponse~~(error: ErrorResponse, block: (ErrorResponseException) -> Unit): RestResult<T>

Runs the given block if the result is the specified error response.

onErrorResponseException

inline fun <T> RestResult<T>.~~onErrorResponseException~~(block: (ErrorResponseException) -> Unit): RestResult<T>

Runs the given block if the result is an ErrorResponseException.

plus

operator fun Timestamp.~~plus~~(duration: Duration): Timestamp

queueIgnoring

fun RestAction<*>.~~queueIgnoring~~(ignored: ErrorResponse, vararg errorResponses: ErrorResponse)

Queues this REST action while ignoring the provided error responses.

recover

inline fun <T : R, R> RestResult<T>.~~recover~~(predicate: (Throwable) -> Boolean, block: (Throwable) -> R): RestResult<R>

Maps the encapsulated exception using the given block if it corresponds to the predicate.

inline fun <T : R, R> RestResult<T>.~~recover~~(type: KClass<out Throwable>, vararg types: KClass<out Throwable>, block: (Throwable) -> R): RestResult<R>

Maps the encapsulated exception using the given block if it corresponds to an ignored exception type.

inline fun <T : R, R> RestResult<T>.~~recover~~(response: ErrorResponse, vararg responses: ErrorResponse, block: (ErrorResponseException) -> R): RestResult<R>

Maps the encapsulated exception using the given block if it corresponds to an ignored response.

replaceWith

fun InteractionHook.~~replaceWith~~(content: String): WebhookMessageEditAction<Message>

fun InteractionHook.~~replaceWith~~(data: MessageCreateData): WebhookMessageEditAction<Message>

fun InteractionHook.~~replaceWith~~(data: MessageEditData): WebhookMessageEditAction<Message>

retrieveBanOrNull

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

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

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): Member?

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

Retrieves a Member with the provided ID.

retrieveMemberOrNull

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

Retrieves a Member with the provided User.

retrieveStickerOrNull

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

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

retrieveThreadChannelById

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

Retrieves a thread by ID.

retrieveThreadChannelOrNull

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

Retrieves a thread by ID.

retrieveUserByIdOrNull

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

suspend fun JDA.~~retrieveUserByIdOrNull~~(userId: String, useCache: Boolean): 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.

runCatchingResponse

inline fun <R> ~~runCatchingResponse~~(ignored: ErrorResponse, vararg ignoredResponses: ErrorResponse, block: () -> R): RestResult<R>

Encapsulates the result of the specified function block and dismisses error responses that corresponds to an ignored response, making the Result a success.

runCatchingRest

inline fun <T> ~~runCatchingRest~~(block: () -> T): RestResult<T>

Calls the specified function block and returns its encapsulated result if invocation was successful, catching any Throwable exception that was thrown from the block function execution and encapsulating it as a failure.

runIgnoringResponse