Package dev.sympho.bot_utils

Class DiscordUtils

java.lang.Object

dev.sympho.bot_utils.DiscordUtils

public final class DiscordUtils
extends Object

Provides assorted utilities for interacting with Discord.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiscordUtils.AttachmentException	Exception that represents an error encountered while creating an attachment.

Method Summary

Modifier and Type	Method	Description
static MessageCreateFields.File	attachData(String filename, byte[] data, boolean spoiler)	Prepares data to be attached to a message as a file.
static MessageCreateFields.File	attachImage(String name, BufferedImage image, boolean spoiler)	Prepares an image to be attached to a message.
static String	mentionChannel(Snowflake id)	Constructs a mention to a channel.
static String	mentionRole(Snowflake id)	Constructs a mention to a role.
static String	mentionUser(Snowflake id)	Constructs a mention to a user.
static <T> discord4j.discordjson.possible.Possible<T>	toPossible(Optional<T> o)	Converts an Optional into a Possible.
static EmbedCreateSpec	toSpec(Embed embed)	Creates an embed spec from an embed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

toPossible

@SideEffectFree
public static <T>
discord4j.discordjson.possible.Possible<T> toPossible(Optional<T> o)

Converts an Optional into a Possible.

Type Parameters:

T - The contained object type.

Parameters:

o - The optional.

Returns:

The possible.

toSpec

@SideEffectFree
public static EmbedCreateSpec toSpec(Embed embed)

Creates an embed spec from an embed.

Parameters:

embed - The embed.

Returns:

The equivalent spec.

mentionUser

@SideEffectFree
public static String mentionUser(Snowflake id)

Constructs a mention to a user.

Parameters:

id - The ID of the user to mention.

Returns:

The mention.

mentionRole

@SideEffectFree
public static String mentionRole(Snowflake id)

Constructs a mention to a role.

Parameters:

id - The ID of the role to mention.

Returns:

The mention.

mentionChannel

@SideEffectFree
public static String mentionChannel(Snowflake id)

Constructs a mention to a channel.

Parameters:

id - The ID of the channel to mention.

Returns:

The mention.

attachData

@SideEffectFree
public static MessageCreateFields.File attachData(String filename,
 byte[] data,
 boolean spoiler)
                                           throws DiscordUtils.AttachmentException

Prepares data to be attached to a message as a file.

Parameters:

filename - The filename.

data - The file data.

spoiler - Whether to mark the file as a spoiler.

Returns:

The prepared attachment.

Throws:

DiscordUtils.AttachmentException - if an error occurs.

attachImage

@SideEffectFree
public static MessageCreateFields.File attachImage(String name,
 BufferedImage image,
 boolean spoiler)
                                            throws DiscordUtils.AttachmentException

Prepares an image to be attached to a message.

Parameters:

name - The image name (filename without extension).

image - The image.

spoiler - Whether to mark the image as a spoiler.

Returns:

The prepared attachment.

Throws:

DiscordUtils.AttachmentException - if an error occurs.