Package io.facet.common

Types

GatewayInteractionResponse

interface GatewayInteractionResponse : InteractionResponse

A handler for common operations related to an interaction followup response.

Functions

actorListener

inline fun <E : Event> GatewayDiscordClient.actorListener(scope: CoroutineScope, context: CoroutineContext = EmptyCoroutineContext, capacity: Int = Channel.RENDEZVOUS, start: CoroutineStart = CoroutineStart.DEFAULT, noinline onCompletion: CompletionHandler? = null, noinline block: suspend ActorScope<E>.() -> Unit): Job

@ObsoleteCoroutinesApi

inline fun <E : Event> EventDispatcher.actorListener(scope: CoroutineScope, context: CoroutineContext = EmptyCoroutineContext, capacity: Int = Channel.RENDEZVOUS, start: CoroutineStart = CoroutineStart.DEFAULT, noinline onCompletion: CompletionHandler? = null, noinline block: suspend ActorScope<E>.() -> Unit): Job

Creates and launches a new coroutine, which launches an actor coroutine and forwards gateway events of the specified type to it's ReceiveChannel.

asULong

fun Snowflake.asULong(): ULong

await

suspend fun <T : Any> Flux<T>.await(): List<T>

Suspends the current coroutine, and returns all elements emitted by the Flux in a List.

@JvmName(name = "awaitVoid")

suspend fun Flux<Void>.await()

Suspends the current coroutine, and returns when the Flux completes.

suspend fun <T : Any> Mono<T>.await(): T

Awaits for the single value from the given Mono, suspending the current coroutine and resuming when the mono emits the resulting value or throws the corresponding exception if this publisher had produced error.

@JvmName(name = "awaitVoid")

suspend fun Mono<Void>.await()

Awaits for the completion signal from the given Mono, suspending the current coroutine and resuming when the mono emits the resulting value or throws the corresponding exception if this publisher had produced error.

awaitComplete

suspend fun Mono<*>.awaitComplete()

awaitNullable

suspend fun <T : Any> Mono<T>.awaitNullable(): T?

Awaits for the single value from the given Mono or null value if none is emitted, suspending the current coroutine and resuming when the mono returns the resulting value or throws the corresponding exception if this publisher had produced error.

distinct

fun <T> Flow<T>.distinct(): Flow<T>

Returns a flow which only emits unique values of type T.

distinctBy

fun <T, K> Flow<T>.distinctBy(selector: (T) -> K): Flow<T>

Returns a flow which only emits unique values determined by the given selector function.

flowOf

inline fun <E : Event> GatewayDiscordClient.flowOf(): Flow<E>

inline fun <E : Event> EventDispatcher.flowOf(): Flow<E>

Returns a Flow of the specified event type.

getAllMemberMentions

@ExperimentalCoroutinesApi

@FlowPreview

suspend fun Message.getAllMemberMentions(): Set<Member>

Gets ALL distinct Member mentions, including users specifically mentioned as well as users mentioned in roles.

getAllUserMentions

@ExperimentalCoroutinesApi

@FlowPreview

suspend fun Message.getAllUserMentions(): Set<User>

Gets ALL distinct User mentions, including users specifically mentioned as well as users mentioned in roles.

getConnectedMemberIds

suspend fun VoiceChannel.getConnectedMemberIds(): Set<Snowflake>

Gets the Snowflake ids of the members currently connected to this voice channel by requesting the VoiceStates of this channel.

getConnectedMembers

suspend fun VoiceChannel.getConnectedMembers(): Set<Member>

Gets the members currently connected to this voice channel by requesting the VoiceStates of this channel.

getConnectedVoiceChannel

suspend fun Guild.getConnectedVoiceChannel(): AudioChannel?

Gets the VoiceChannel that our user is connected to in this Guild.

suspend fun Member.getConnectedVoiceChannel(): AudioChannel?

Gets the VoiceChannel that the member is currently connected to, if present.

getMembers

@FlowPreview

suspend fun Role.getMembers(): List<Member>

Gets the members with this role by requesting the members of this guild and filtering by this role's Snowflake ID.

getOurVoiceState

suspend fun Guild.getOurVoiceState(): VoiceState?

Gets the VoiceState of our user in this Guild.

getVoiceChannelByName

suspend fun Guild.getVoiceChannelByName(name: String): AudioChannel?

Returns the first VoiceChannel found with the specified name.

grab

~~fun~~ <T : Any> Optional<T>.~~grab~~(): T?

listener

inline fun <E : Event> GatewayDiscordClient.listener(scope: CoroutineScope, context: CoroutineContext = EmptyCoroutineContext, capacity: Int = Channel.RENDEZVOUS, start: CoroutineStart = CoroutineStart.DEFAULT, crossinline block: suspend CoroutineScope.(E) -> Unit): Job

inline fun <E : Event> EventDispatcher.listener(scope: CoroutineScope, context: CoroutineContext = EmptyCoroutineContext, capacity: Int = Channel.RENDEZVOUS, start: CoroutineStart = CoroutineStart.DEFAULT, crossinline block: suspend CoroutineScope.(E) -> Unit): Job

Creates and launches a new coroutine, which listens to the specified Event type and calls the block function whenever a new event of that type is received by the gateway.

mergeWith

@ExperimentalCoroutinesApi

fun <T> Flow<T>.mergeWith(other: Flow<T>): Flow<T>

Merge two flows together.

inline fun <E : Event> GatewayDiscordClient.on(): Flux<E>

inline fun <E : Event> EventDispatcher.on(): Flux<E>

Helper function to make listening to discord events shorter.

suspend fun Message.reply(spec: EmbedCreateSpec): Message

Sends a Message with an embed as a reply to the receiver, building the embed from the specified EmbedCreateSpec.

suspend fun Message.reply(spec: MessageCreateSpec): Message

Sends a Message as a reply to the receiver, building the message from the specified MessageCreateSpec.

suspend fun Message.reply(builder: MessageBuilder.() -> Unit): Message

Sends a Message as a reply to the receiver, building the message from the specified MessageBuilder.

suspend fun Message.reply(content: String, mention: Boolean = true): Message

Sends a Message as a reply to the receiver, building the message from the specified content.

replyEmbed

suspend fun Message.replyEmbed(mention: Boolean = true, builder: EmbedBuilder.() -> Unit): Message

Sends a Message with an embed as a reply to the receiver, building the embed from the specified EmbedBuilder.

retry

inline suspend fun <T> retry(n: Int, errorDelayMillis: Long, fn: (counter: Int) -> T): T

sendEmbed

~~suspend~~ ~~fun~~ MessageChannel.~~sendEmbed~~(~~spec~~: EmbedCreateSpec): Message

Sends an embed in the specified channel based on the EmbedCreateSpec.

suspend fun MessageChannel.sendEmbed(block: EmbedBuilder.() -> Unit): Message

Builds an EmbedCreateSpec and sends it in the specified channel.

sendFollowupEmbed

suspend fun GatewayInteractionResponse.sendFollowupEmbed(build: EmbedBuilder.() -> Unit): Message

Create and send a new followup message containing an embed built from the specified builder. This uses a webhook tied to the interaction ID and token.

sendFollowupEmbedEphemeral

suspend fun GatewayInteractionResponse.sendFollowupEmbedEphemeral(build: EmbedBuilder.() -> Unit): Message

Create and send a new ephemeral followup message containing an embed built from the specified builder. This uses a webhook tied to the interaction ID and token.

sendFollowupMessage

suspend fun InteractionResponse.sendFollowupMessage(spec: EmbedCreateSpec): MessageData

Create and send a new followup message containing an embed from the specified EmbedCreateSpec. This uses a webhook tied to the interaction ID and token.

suspend fun InteractionResponse.sendFollowupMessage(spec: WebhookExecuteSpec): MessageData

Create and send a new followup message using the provided WebhookExecuteSpec. This uses a webhook tied to the interaction ID and token.

suspend fun InteractionResponse.sendFollowupMessage(build: WebhookMessageBuilder.() -> Unit): MessageData

Create and send a new followup message, using the WebhookMessageBuilder to build the request. This uses a webhook tied to the interaction ID and token.

suspend fun InteractionResponse.sendFollowupMessage(content: String): MessageData

Create and send a new followup message with the provided content. This uses a webhook tied to the interaction ID and token.

suspend fun GatewayInteractionResponse.sendFollowupMessage(spec: EmbedCreateSpec): Message

Create and send a new followup message containing an embed from the specified spec. This uses a webhook tied to the interaction ID and token.

suspend fun GatewayInteractionResponse.sendFollowupMessage(build: WebhookMessageBuilder.() -> Unit): Message

Create and send a new followup message, using the builder to build the request. This uses a webhook tied to the interaction ID and token.

sendFollowupMessageEphemeral

suspend fun GatewayInteractionResponse.sendFollowupMessageEphemeral(spec: EmbedCreateSpec): Message

Create and send a new ephemeral followup message containing an embed from the specified spec. This uses a webhook tied to the interaction ID and token.