Package dev.aura.bungeechat.api

Interface BungeeChatApi

public interface BungeeChatApi

This is the base Interface for the BungeeChatApi. The central methods will be found here

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUTHOR_BRAINSTONE
static String	AUTHOR_SHAWN
static String[]	AUTHORS
static int	BUILD
static BuildType	BUILD_TYPE
static double	CONFIG_VERSION
static String[]	CONTRIBUTORS
static String	DESCRIPTION
static String[]	DONATORS
static String	ID
static String	NAME
static int	PLUGIN_ID
static String[]	TRANSLATORS
static String	URL
static dev.aura.lib.version.Version	VERSION
static String	VERSION_STR

Method Summary

Modifier and Type	Method	Description
File	getConfigFolder()	Retrieves (and creates if necessary) the config folder.
static BungeeChatApi	getInstance()	Method to retrieve the instance of the API
default void	sendChannelMessage(BungeeChatContext context)	The same as sendChannelMessage(BungeeChatContext, ChannelType).
void	sendChannelMessage(BungeeChatContext context, ChannelType channel)	Sends a message from the sender in the context to the specified channel.
void	sendPrivateMessage(BungeeChatContext context)	Send a private message.

Field Detail

ID

static final String ID

See Also:

Constant Field Values

NAME

static final String NAME

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

See Also:

Constant Field Values

VERSION_STR

static final String VERSION_STR

See Also:

Constant Field Values

VERSION

static final dev.aura.lib.version.Version VERSION

BUILD_TYPE

static final BuildType BUILD_TYPE

BUILD

static final int BUILD

URL

static final String URL

See Also:

Constant Field Values

AUTHOR_BRAINSTONE

static final String AUTHOR_BRAINSTONE

See Also:

Constant Field Values

AUTHOR_SHAWN

static final String AUTHOR_SHAWN

See Also:

Constant Field Values

AUTHORS

static final String[] AUTHORS

CONTRIBUTORS

static final String[] CONTRIBUTORS

TRANSLATORS

static final String[] TRANSLATORS

DONATORS

static final String[] DONATORS

CONFIG_VERSION

static final double CONFIG_VERSION

See Also:

Constant Field Values

PLUGIN_ID

static final int PLUGIN_ID

See Also:

Constant Field Values

Method Detail

getInstance

static BungeeChatApi getInstance()

Method to retrieve the instance of the API

Returns:

The BungeeChatApi instance

getConfigFolder

File getConfigFolder()

Retrieves (and creates if necessary) the config folder.

Returns:

The existing config folder

sendPrivateMessage

void sendPrivateMessage(BungeeChatContext context)
                 throws InvalidContextError

Send a private message. The context contains the sender, the target and the message!

Parameters:

context - Containing sender, target and message.

Throws:

InvalidContextError - Throws and InvalidContextError if either a sender, target or message is missing in this context.

sendChannelMessage

void sendChannelMessage(BungeeChatContext context,
                        ChannelType channel)
                 throws InvalidContextError

Sends a message from the sender in the context to the specified channel. The message has to be in the context.

Parameters:

context - Containing sender and message.

channel - What channel to send the message in.

Throws:

InvalidContextError - Throws and InvalidContextError if either a sender or message is missing in this context.

sendChannelMessage

default void sendChannelMessage(BungeeChatContext context)
                         throws InvalidContextError

The same as sendChannelMessage(BungeeChatContext, ChannelType). But uses the channel the sender is currently in.

Parameters:

context - Containing sender and message.

Throws:

InvalidContextError - Throws and InvalidContextError if either a sender or message is missing in this context.