Package pro.cloudnode.smp.cloudnodemsg

Class Message

java.lang.Object

pro.cloudnode.smp.cloudnodemsg.Message

public final class Message
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Message.Context	The context in which this message is sent

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull NamespacedKey	CHANNEL_RECIPIENT
static final @NotNull NamespacedKey	CHANNEL_TEAM
static final @NotNull OfflinePlayer	console
static final @NotNull NamespacedKey	IGNORED_PLAYERS
static final @NotNull NamespacedKey	INCOMING_ENABLED
static final @NotNull NamespacedKey	REPLY_TO

Constructor Summary

Constructors

Constructor	Description
Message(@NotNull OfflinePlayer sender, @NotNull OfflinePlayer recipient, @NotNull String message)
Message(@NotNull OfflinePlayer sender, @NotNull OfflinePlayer recipient, @NotNull Component message)

Method Summary

Modifier and Type	Method	Description
static void	createChannel(@NotNull Player player, @NotNull OfflinePlayer recipient)	Create DM channel to player
static void	createTeamChannel(@NotNull Player player)	Team message channel
static void	exitChannel(@NotNull Player player)	Exit DM channel
static void	exitTeamChannel(@NotNull Player player)	Exit team message channel
static @NotNull Optional<@NotNull OfflinePlayer>	getChannel(@NotNull Player player)	Get DM channel recipient
static @NotNull HashSet<@NotNull UUID>	getIgnored(@NotNull Player player)	Get UUID set of ignored players from PDC string
static @NotNull Optional<@NotNull OfflinePlayer>	getReplyTo(@NotNull OfflinePlayer player)
static boolean	hasChannel(@NotNull Player player)	Check whether player has DM channel
static boolean	hasChannel(@NotNull Player player, @NotNull OfflinePlayer recipient)	Check whether player has DM channel with recipient
static boolean	hasTeamChannel(@NotNull Player player)	Check whether player has a team message channel
static void	ignore(@NotNull Player player, @NotNull OfflinePlayer ignore)	Ignore a player
static void	incomingDisable(@NotNull Player player)	Denies player to receive private messages
static void	incomingEnable(@NotNull Player player)	Allows player to receive private messages
static boolean	isIgnored(@NotNull Player player, @NotNull OfflinePlayer ignored)	Check if a player is ignored
static boolean	isIncomingEnabled(@NotNull Player player)	Check if a player allows private messages
static @NotNull OfflinePlayer	offlinePlayer(@NotNull CommandSender executor)
static void	removeReplyTo(@NotNull OfflinePlayer player)
void	send()
void	send(@NotNull Message.Context context)
static void	sendMessage(@NotNull OfflinePlayer recipient, @NotNull Component message)
static void	sendSpyMessage(@NotNull OfflinePlayer sender, @NotNull OfflinePlayer recipient, @NotNull Component message)	Send social spy to online players with permission
static void	setReplyTo(@NotNull OfflinePlayer sender, @NotNull OfflinePlayer recipient)
static void	unignore(@NotNull Player player, @NotNull OfflinePlayer ignored)	Unignore a player

Methods inherited from class java.lang.Object

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

Field Details

console

@NotNull
public static final @NotNull OfflinePlayer console

REPLY_TO

@NotNull
public static final @NotNull NamespacedKey REPLY_TO

IGNORED_PLAYERS

@NotNull
public static final @NotNull NamespacedKey IGNORED_PLAYERS

CHANNEL_RECIPIENT

@NotNull
public static final @NotNull NamespacedKey CHANNEL_RECIPIENT

CHANNEL_TEAM

@NotNull
public static final @NotNull NamespacedKey CHANNEL_TEAM

INCOMING_ENABLED

@NotNull
public static final @NotNull NamespacedKey INCOMING_ENABLED

Constructor Details

Message

public Message(@NotNull
 @NotNull OfflinePlayer sender,
 @NotNull
 @NotNull OfflinePlayer recipient,
 @NotNull
 @NotNull Component message)

Message

public Message(@NotNull
 @NotNull OfflinePlayer sender,
 @NotNull
 @NotNull OfflinePlayer recipient,
 @NotNull
 @NotNull String message)

Method Details

send

public void send()
          throws InvalidPlayerError

Throws:

InvalidPlayerError

send

public void send(@NotNull
 @NotNull Message.Context context)
          throws InvalidPlayerError

Throws:

InvalidPlayerError

offlinePlayer

@NotNull
public static @NotNull OfflinePlayer offlinePlayer(@NotNull
 @NotNull CommandSender executor)

sendMessage

public static void sendMessage(@NotNull
 @NotNull OfflinePlayer recipient,
 @NotNull
 @NotNull Component message)

sendSpyMessage

public static void sendSpyMessage(@NotNull
 @NotNull OfflinePlayer sender,
 @NotNull
 @NotNull OfflinePlayer recipient,
 @NotNull
 @NotNull Component message)

Send social spy to online players with permission

setReplyTo

public static void setReplyTo(@NotNull
 @NotNull OfflinePlayer sender,
 @NotNull
 @NotNull OfflinePlayer recipient)

getReplyTo

@NotNull
public static @NotNull Optional<@NotNull OfflinePlayer> getReplyTo(@NotNull
 @NotNull OfflinePlayer player)

removeReplyTo

public static void removeReplyTo(@NotNull
 @NotNull OfflinePlayer player)

getIgnored

@NotNull
public static @NotNull HashSet<@NotNull UUID> getIgnored(@NotNull
 @NotNull Player player)

Get UUID set of ignored players from PDC string

Parameters:

player - The player

isIgnored

public static boolean isIgnored(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull OfflinePlayer ignored)

Check if a player is ignored

Parameters:

player - The player

ignored - The ignored player

ignore

public static void ignore(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull OfflinePlayer ignore)

Ignore a player

Parameters:

player - The player

ignore - The player to ignore

unignore

public static void unignore(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull OfflinePlayer ignored)

Unignore a player

Parameters:

player - The player

ignored - The player to unignore

incomingEnable

public static void incomingEnable(@NotNull
 @NotNull Player player)

Allows player to receive private messages

Parameters:

player - The player

incomingDisable

public static void incomingDisable(@NotNull
 @NotNull Player player)

Denies player to receive private messages

Parameters:

player - The player

isIncomingEnabled

public static boolean isIncomingEnabled(@NotNull
 @NotNull Player player)

Check if a player allows private messages

Parameters:

player - The player

createChannel

public static void createChannel(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull OfflinePlayer recipient)

Create DM channel to player

Parameters:

player - The player (you)

recipient - The other end of the channel

exitChannel

public static void exitChannel(@NotNull
 @NotNull Player player)

Exit DM channel

Parameters:

player - The player (you)

getChannel

@NotNull
public static @NotNull Optional<@NotNull OfflinePlayer> getChannel(@NotNull
 @NotNull Player player)

Get DM channel recipient

Parameters:

player - The player

hasChannel

public static boolean hasChannel(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull OfflinePlayer recipient)

Check whether player has DM channel with recipient

Parameters:

player - The player

recipient - The recipient

hasChannel

public static boolean hasChannel(@NotNull
 @NotNull Player player)

Check whether player has DM channel

Parameters:

player - The player

createTeamChannel

public static void createTeamChannel(@NotNull
 @NotNull Player player)

Team message channel

Parameters:

player - The player

exitTeamChannel

public static void exitTeamChannel(@NotNull
 @NotNull Player player)

Exit team message channel

Parameters:

player - The player

hasTeamChannel

public static boolean hasTeamChannel(@NotNull
 @NotNull Player player)

Check whether player has a team message channel

Parameters:

player - The player