Package me.remigio07.chatplugin.api.common.event.discord

Class PlainMessageSendEvent

java.lang.Object

me.remigio07.chatplugin.api.common.event.discord.PlainMessageSendEvent

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent

public class PlainMessageSendEvent
extends Object
implements ChatPluginEvent, CancellableEvent

Represents the event called just before a plain message is sent through the DiscordBot.

See Also:

• DiscordBot.sendPlainMessage(long, String)

Constructor Summary

Constructors

Constructor	Description
PlainMessageSendEvent(long channelID, String plainMessage)	Constructs a new plain message send event.

Method Summary

Modifier and Type	Method	Description
long	getChannelID()	Gets the ID of the channel the plain message has been sent through.
String	getPlainMessage()	Gets this event's plain message.
boolean	isCancelled()	Checks if this event has been cancelled and will not be executed.
void	setCancelled(boolean cancelled)	Sets the cancellation state of this event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.remigio07.chatplugin.api.common.event.ChatPluginEvent

call

Constructor Details

PlainMessageSendEvent

public PlainMessageSendEvent(long channelID,
 String plainMessage)

Constructs a new plain message send event.

Parameters:

channelID - Event's channel's ID

plainMessage - Plain message involved

Method Details

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Checks if this event has been cancelled and will not be executed.

Specified by:

isCancelled in interface CancellableEvent

Returns:

Whether this event is cancelled

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: CancellableEvent

Sets the cancellation state of this event.

It will be passed through other registered listeners even if it is cancelled, but it will not be executed.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - Whether this event should be cancelled

getChannelID

public long getChannelID()

Gets the ID of the channel the plain message has been sent through.

Returns:

Event's channel's ID

getPlainMessage

public String getPlainMessage()

Gets this event's plain message.

Returns:

Plain message involved