io.github.nucleuspowered.nucleus.api.module.nameban

Interface NucleusNameBanService

public interface NucleusNameBanService

Manages player names that are prohibited from joining a server.

Method Summary

Modifier and Type	Method and Description
void	addName(java.lang.String name, java.lang.String reason, org.spongepowered.api.event.cause.Cause cause) Adds a name to a blacklist, preventing them from joining the server.
java.util.Optional<java.lang.String>	getReasonForBan(java.lang.String name) If a name is banned, returns the reason.
void	removeName(java.lang.String name, org.spongepowered.api.event.cause.Cause cause) Removes a name from the blacklist.

Method Detail

addName

void addName(java.lang.String name,
             java.lang.String reason,
             org.spongepowered.api.event.cause.Cause cause)
      throws NameBanException

Adds a name to a blacklist, preventing them from joining the server.

Parameters:

name - The name

reason - The reason to give for the banning

cause - The Cause of this request

Throws:

NameBanException - thrown if the name could not be added to the list

getReasonForBan

java.util.Optional<java.lang.String> getReasonForBan(java.lang.String name)

If a name is banned, returns the reason.

Parameters:

name - The name to get the reason for

Returns:

The reason if the name is banned

removeName

void removeName(java.lang.String name,
                org.spongepowered.api.event.cause.Cause cause)
         throws NameBanException

Removes a name from the blacklist.

Parameters:

name - The name to remove

cause - The Cause of this request

Throws:

NameBanException - thrown if the name could not be removed from the list