Compute the permissions for the given guild member in the channel in the guild. Takes into account the permission overwrites and whether or not the user is an administrator.

suspend fun computePermissions(user: User, channel: GuildChannel, restClient: RestClient): Permissions

Compute the permissions for the given user in the channel. Takes into account the permission overwrites and whether the user is an administrator.

createThreadFromMessage

suspend fun ChannelClient.createThreadFromMessage(message: Message, createThread: CreateThread): GuildThread

Create a thread from an existing message.

getAllGuilds

suspend fun GlobalClient.getAllGuilds(): List<PartialGuild>

Fetches all guilds from the GuildClient over potentially multiple API calls

gif

fun Emoji.gif(size: Int? = null): String?

Gets the url of the emoji in GIF format, null if the emoji is a unicode character.

gifAvatar

fun User.gifAvatar(size: Int? = null): String?

Gets the url of the user's avatar in GIF format.

jpgAvatar

fun User.jpgAvatar(size: Int? = null): String?

Gets the url of the user's avatar in JPG format.

jpgIcon

fun Guild.jpgIcon(size: Int? = null): String?

Gets the url of the guild icon in JPG format. Null if there is no custom icon.

fun PartialGuild.jpgIcon(size: Int? = null): String?

Gets the url of the guild icon in PNG format. Null if there is no custom icon.

jpgSplash

fun Guild.jpgSplash(size: Int? = null): String?

Gets the url of the guild splash in JPG format. Null if there is no splash.

messageResponse

suspend fun InteractionClient.messageResponse(interactionId: String, message: String, ephemeral: Boolean)

Convenience method for responding to an interaction with a message

png

fun Emoji.png(size: Int? = null): String?

Gets the url of the emoji in PNG format, null if the emoji is a unicode character.

pngAvatar

fun User.pngAvatar(size: Int? = null): String

Gets the url of the user's avatar in PNG format.

pngDefaultAvatar

fun User.pngDefaultAvatar(size: Int? = null): String

Gets the url of the user's default avatar in PNG format.

pngIcon

fun Guild.pngIcon(size: Int? = null): String?

fun PartialGuild.pngIcon(size: Int? = null): String?

Gets the url of the guild icon in PNG format. Null if there is no custom icon.

pngSplash

fun Guild.pngSplash(size: Int? = null): String?

Gets the url of the guild splash in PNG format. Null if there is no splash.

removeThreadMember

suspend fun ChannelClient.removeThreadMember(member: GuildMember)

suspend fun ChannelClient.removeThreadMember(member: ThreadMember)

suspend fun ChannelClient.removeThreadMember(user: User)

Remove a user from the current thread.

sendEmbed

suspend fun ChannelClient.sendEmbed(message: String = "", components: List<ActionRow>? = null, block: Embed.() -> Unit): Message

Calls ChannelClient.createMessage for embedded messages without needing to create a CreateMessage object first. Also accepts a lambda that can be used to configure an Embed object.

sendEmbeddedImage

suspend fun ChannelClient.sendEmbeddedImage(message: String = "", image: FileData, block: Embed.() -> Unit): Message

Calls ChannelClient.createMessage for embedded messages and images without needing to create a CreateMessage object first. Also accepts a lambda that can be used to configure an Embed object.

sendEmbeddedImageReply

suspend fun ChannelClient.sendEmbeddedImageReply(message: Message, reply: String = "", image: FileData, block: Embed.() -> Unit): Message

Calls ChannelClient.createMessage to reply to a specific text message with an embedded message and image without needing to create a CreateMessage object first. Also accepts a lambda that can be used to configure an Embed object.

sendEmbeddedReply

suspend fun ChannelClient.sendEmbeddedReply(message: Message, reply: String = "", components: List<ActionRow>? = null, block: Embed.() -> Unit): Message

Calls ChannelClient.createMessage to reply to a specific text message with an embedded message without needing to create a CreateMessage object first. Also accepts a lambda that can be used to configure an Embed object.

sendFile

suspend fun ChannelClient.sendFile(data: FileData, comment: String = ""): Message

Calls ChannelClient.createMessage for to attach a file without needing to create a CreateMessage object first.

suspend fun ChannelClient.sendFile(file: File, comment: String = ""): Message

suspend fun ChannelClient.sendFile(path: Path, comment: String = ""): Message

Calls ChannelClient.createMessage for text messages without needing to create a CreateMessage object first.

sendMessage

suspend fun ChannelClient.sendMessage(message: String = "", vararg embeds: Embed, components: List<ActionRow>? = null): Message

Calls ChannelClient.createMessage for text messages without needing to create a CreateMessage object first.

sendReply

suspend fun ChannelClient.sendReply(message: Message, reply: String = "", embed: Embed? = null, components: List<ActionRow>? = null): Message

Calls ChannelClient.createMessage to reply to a specific text message without needing to create a CreateMessage object first.

timestamp

fun timestamp(time: Instant, format: TimestampFormat): String

Creates a Discord compatible timestamp, which shows dates and times adjusted for each user's timezone.

toBase64

fun File.toBase64(): String

Converts a File to a base64 encoded String.

toByteArray

fun File.toByteArray(): ByteArray

Converts a File to a ByteArray.

toFileData

fun ByteArray.~~toFileData~~(filename: String, offset: Int = 0, length: Int = size - offset): FileData

fun ByteArray.toFileData(filename: String, contentType: String?, offset: Int = 0, length: Int = size - offset): FileData

Converts a ByteArray to a FileData object.

fun File.toFileData(contentType: String? = null): FileData

Converts a File to a FileData object.

fun Path.toFileData(contentType: String? = null): FileData

Converts a Path to a FileData object.

toRoleMention

fun String.toRoleMention(): String

Convenience method to turn a role id into a formatted mention for chat.

toTimestamp

fun Instant.toTimestamp(format: TimestampFormat = TimestampFormat.RELATIVE): String

Creates a Discord compatible timestamp, which shows dates and times adjusted for each user's timezone.

toUserMention

fun String.toUserMention(): String

Convenience method to turn a user id into a formatted mention for chat.

webpAvatar

fun User.webpAvatar(size: Int? = null): String?

Gets the url of the user's avatar in WEBP format.

webpIcon

fun Guild.webpIcon(size: Int? = null): String?

Gets the url of the guild icon in WEBP format. Null if there is no custom icon.

fun PartialGuild.webpIcon(size: Int? = null): String?

Gets the url of the guild icon in PNG format. Null if there is no custom icon.

webpSplash

fun Guild.webpSplash(size: Int? = null): String?

Gets the url of the guild splash in WEBP format. Null if there is no splash.

withBold

fun String.withBold(): String

Shortcut to bold text.

withItalics

fun String.withItalics(): String

Shortcut to add a italics to text.

withMultiLineCode

fun String.withMultiLineCode(): String

Shortcut to put the code in a multi line code block.

fun String.withMultiLineCode(language: String): String

Shortcut to put the code in a multi line code block with a language style.

withSingleLineCode

fun String.withSingleLineCode(): String

Shortcut to put the code in a single line code block.

withSpoiler

fun String.withSpoiler(): String

Shortcut to add a spoiler to text.

withStrikethrough

fun String.withStrikethrough(): String

Shortcut to add a strikethrough to text.

withUnderline

fun String.withUnderline(): String

Shortcut to add an underline to text.