io.github.nucleuspowered.nucleus.api.module.message

Interface NucleusPrivateMessagingService

public interface NucleusPrivateMessagingService

A service that contains message related APIs.

Method Summary

Modifier and Type	Method and Description
boolean	canSpyOn(org.spongepowered.api.entity.living.player.User spyingUser, org.spongepowered.api.command.CommandSource... sourcesToSpyOn) Returns whether the specified user can spy on all of the specified sources.
boolean	canSpySameLevel() If using social spy levels, this returns whether those on the same social spy level as the participants of a message can read a message.
<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> void	clearCommandSourceReplyTo(T user) Removes the CommandSource that the specified CommandSource will reply to if /r is used.
void	clearConsoleReplyTo() Removes the CommandSource that the console will reply to if /r is used.
void	clearReplyTo(org.spongepowered.api.entity.living.player.User user) Removes the CommandSource that the specified User will reply to if /r is used.
org.spongepowered.api.util.Tristate	forcedSocialSpyState(org.spongepowered.api.entity.living.player.User user) Returns whether the specified user can toggle social spy Tristate.UNDEFINED, or whether they are forced to use social spy Tristate.TRUE, or do not have permission to do so Tristate.FALSE.
<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> java.util.Optional<org.spongepowered.api.command.CommandSource>	getCommandSourceReplyTo(T from) Gets the CommandSource that the specified T will reply to if /r is used, if any.
java.util.Optional<org.spongepowered.api.command.CommandSource>	getConsoleReplyTo() Gets the CommandSource that the console will reply to if /r is used, if any.
int	getCustomTargetLevel() Gets the social spy level for any message targets registered using registerMessageTarget(UUID, String, Text, Supplier).
java.util.Optional<org.spongepowered.api.command.CommandSource>	getReplyTo(org.spongepowered.api.entity.living.player.User from) Gets the CommandSource that the specified User will reply to if /r is used, if any.
int	getServerLevel() Gets the social spy level the server is assigned.
int	getSocialSpyLevel(org.spongepowered.api.entity.living.player.User user) Gets the social spy level the user is assigned.
boolean	isSocialSpy(org.spongepowered.api.entity.living.player.User user) Returns whether the user is able to see all private messages sent on the server.
boolean	isUsingSocialSpyLevels() Returns whether the server is using social spy levels.
java.util.Set<org.spongepowered.api.command.CommandSource>	onlinePlayersCanSpyOn(boolean includeConsole, org.spongepowered.api.command.CommandSource... sourcesToSpyOn) Returns the CommandSources that are online and can spy on all of the specified sources.
<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> void	registerMessageTarget(java.util.UUID uniqueId, java.lang.String targetName, org.spongepowered.api.text.Text displayName, java.util.function.Supplier<T> target) Registers a message target.
boolean	sendMessage(org.spongepowered.api.command.CommandSource sender, org.spongepowered.api.command.CommandSource receiver, java.lang.String message) Sends a message as the sender to the receiver.
<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> void	setCommandSourceReplyTo(T source, org.spongepowered.api.command.CommandSource replyTo) Sets the CommandSource that the specified CommandSource will reply to if /r is used.
void	setConsoleReplyTo(org.spongepowered.api.command.CommandSource toReplyTo) Sets the CommandSource that the console will reply to if /r is used.
void	setReplyTo(org.spongepowered.api.entity.living.player.User user, org.spongepowered.api.command.CommandSource toReplyTo) Sets the CommandSource that the specified User will reply to if /r is used.
boolean	setSocialSpy(org.spongepowered.api.entity.living.player.User user, boolean isSocialSpy) Sets whether the user is able to see all private messages on the server.

Method Detail

isSocialSpy

boolean isSocialSpy(org.spongepowered.api.entity.living.player.User user)

Returns whether the user is able to see all private messages sent on the server. This indicates that the user has the correct permission AND has activated it.

Parameters:

user - The User to check.

Returns:

true if the user has Social Spy enabled.

isUsingSocialSpyLevels

boolean isUsingSocialSpyLevels()

Returns whether the server is using social spy levels.

Returns:

true if so.

canSpySameLevel

boolean canSpySameLevel()

If using social spy levels, this returns whether those on the same social spy level as the participants of a message can read a message.

In the following scenarios, Alice has a social spy level of 5, and Bob a social spy level of 10.

If this method returns true, and Alice sends a message to Bob, Eve must have a level of 10 or above, to see the message. If Eve has a level of 9 or below, then because Bob's level is higher than hers, she cannot see the message.

If this method returns false, and Alice sends a message to Bob, Eve must have a level of 11 or above, to see the message. If Eve has a level of 10 or below, then because Bob's level is the same than hers, she cannot see the message.

Returns:

Whether the server allows those with the same social spy level to spy on each other.

getCustomTargetLevel

int getCustomTargetLevel()

Gets the social spy level for any message targets registered using registerMessageTarget(UUID, String, Text, Supplier).

Returns:

The target's social spy level.

getServerLevel

int getServerLevel()

Gets the social spy level the server is assigned. Typically (but not always) this is Integer.MAX_VALUE, or zero if levels aren't enabled.

Returns:

The console/server's social spy level.

getSocialSpyLevel

int getSocialSpyLevel(org.spongepowered.api.entity.living.player.User user)

Gets the social spy level the user is assigned. This is zero by default.

Parameters:

user - The user to check.

Returns:

The level.

forcedSocialSpyState

org.spongepowered.api.util.Tristate forcedSocialSpyState(org.spongepowered.api.entity.living.player.User user)

Returns whether the specified user can toggle social spy Tristate.UNDEFINED, or whether they are forced to use social spy Tristate.TRUE, or do not have permission to do so Tristate.FALSE.

Parameters:

user - The use to check.

Returns:

A Tristate that indicates what state the user might be forced into.

setSocialSpy

boolean setSocialSpy(org.spongepowered.api.entity.living.player.User user,
                     boolean isSocialSpy)

Sets whether the user is able to see all private messages on the server. This method will return whether the system has fulfilled the request.

Parameters:

user - The User

isSocialSpy - true to turn Social Spy on, false otherwise.

Returns:

true if the change was fulfilled, false if the user does not have permission

canSpyOn

boolean canSpyOn(org.spongepowered.api.entity.living.player.User spyingUser,
                 org.spongepowered.api.command.CommandSource... sourcesToSpyOn)
          throws java.lang.IllegalArgumentException

Returns whether the specified user can spy on all of the specified sources.

This will return false if the spying user is also in the list of users to spy on.

Parameters:

spyingUser - The user that will be spying.

sourcesToSpyOn - The CommandSources to spy upon.

Returns:

true if the user can spy on all the users.

Throws:

java.lang.IllegalArgumentException - thrown if no CommandSources are supplied.

onlinePlayersCanSpyOn

java.util.Set<org.spongepowered.api.command.CommandSource> onlinePlayersCanSpyOn(boolean includeConsole,
                                                                                 org.spongepowered.api.command.CommandSource... sourcesToSpyOn)
                                                                          throws java.lang.IllegalArgumentException

Returns the CommandSources that are online and can spy on all of the specified sources.

This will not return players in the list of users to spy on.

Parameters:

includeConsole - Whether to include the console in the returned Set.

sourcesToSpyOn - The CommandSources to spy upon.

Returns:

A Set of CommandSources that can spy upon the specified users.

Throws:

java.lang.IllegalArgumentException - thrown if no CommandSources are supplied.

sendMessage

boolean sendMessage(org.spongepowered.api.command.CommandSource sender,
                    org.spongepowered.api.command.CommandSource receiver,
                    java.lang.String message)

Sends a message as the sender to the receiver. Takes a string to mirror what the command would do.

Parameters:

sender - The sender.

receiver - The reciever.

message - The message to send.

Returns:

true if the message was sent, false otherwise.

getConsoleReplyTo

java.util.Optional<org.spongepowered.api.command.CommandSource> getConsoleReplyTo()

Gets the CommandSource that the console will reply to if /r is used, if any.

Returns:

The CommandSource.

getReplyTo

java.util.Optional<org.spongepowered.api.command.CommandSource> getReplyTo(org.spongepowered.api.entity.living.player.User from)

Gets the CommandSource that the specified User will reply to if /r is used, if any.

Parameters:

from - The User to inspect.

Returns:

The CommandSource.

getCommandSourceReplyTo

<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> java.util.Optional<org.spongepowered.api.command.CommandSource> getCommandSourceReplyTo(T from)

Gets the CommandSource that the specified T will reply to if /r is used, if any.

Type Parameters:

T - The Identifiable CommandSource type.

Parameters:

from - The T to inspect.

Returns:

The CommandSource.

setReplyTo

void setReplyTo(org.spongepowered.api.entity.living.player.User user,
                org.spongepowered.api.command.CommandSource toReplyTo)

Sets the CommandSource that the specified User will reply to if /r is used.

Parameters:

user - The User to modify.

toReplyTo - The CommandSource.

setConsoleReplyTo

void setConsoleReplyTo(org.spongepowered.api.command.CommandSource toReplyTo)

Sets the CommandSource that the console will reply to if /r is used.

Parameters:

toReplyTo - The CommandSource.

setCommandSourceReplyTo

<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> void setCommandSourceReplyTo(T source,
                                                                                                                               org.spongepowered.api.command.CommandSource replyTo)

Sets the CommandSource that the specified CommandSource will reply to if /r is used.

If the CommandSource in both cases isn't a normal target or isn't registered, this will fail silently.

Type Parameters:

T - The Identifiable CommandSource type.

Parameters:

source - The T to modify.

replyTo - The CommandSource to now reply to.

clearReplyTo

void clearReplyTo(org.spongepowered.api.entity.living.player.User user)

Removes the CommandSource that the specified User will reply to if /r is used.

Parameters:

user - The User to modify.

clearCommandSourceReplyTo

<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> void clearCommandSourceReplyTo(T user)

Removes the CommandSource that the specified CommandSource will reply to if /r is used.

Type Parameters:

T - The Identifiable CommandSource type.

Parameters:

user - The User to modify.

clearConsoleReplyTo

void clearConsoleReplyTo()

Removes the CommandSource that the console will reply to if /r is used.

registerMessageTarget

<T extends org.spongepowered.api.command.CommandSource & org.spongepowered.api.util.Identifiable> void registerMessageTarget(java.util.UUID uniqueId,
                                                                                                                             java.lang.String targetName,
                                                                                                                             @Nullable
                                                                                                                             org.spongepowered.api.text.Text displayName,
                                                                                                                             java.util.function.Supplier<T> target)
                                                                                                                      throws java.lang.NullPointerException,
                                                                                                                             java.lang.IllegalArgumentException,
                                                                                                                             java.lang.IllegalStateException

Registers a message target. The target's UUID must remain constant, otherwise Nucleus will treat any interaction as coming from the console.

A message target is, perhaps unsurprisingly, a valid target for messaging. Players can message this target using /m <targetName> [message]

Message targets cannot be ignored. They are mostly intended for bot use.

Type Parameters:

T - The type that implements both CommandSource and Identifiable.

Parameters:

uniqueId - The UUID of the target.

targetName - The name of the target in commands.

displayName - The display name of the target. If null, CommandSource.getName() is used.

target - A Supplier of the message target, which must implement both CommandSource and Identifiable.

Throws:

java.lang.NullPointerException - thrown if any non Nullable parameter is null.

java.lang.IllegalArgumentException - thrown if the UUID is the zero UUID.

java.lang.IllegalStateException - thrown if the UUID has already been registered.