Interface ModerationService

public interface ModerationService

Bans, mutes, kicks and their shared history. Every mutating method fires the matching cancellable event (see fr.mathildeuh.youneedme.api.event) synchronously on the calling thread before doing any I/O, so listeners can veto a punishment before it is persisted.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<@Nullable Punishment>	activeBan(UUID target)
CompletableFuture<@Nullable Punishment>	activeIpBan(String ip)
CompletableFuture<@Nullable Punishment>	activeMute(UUID target)
CompletableFuture<List<Punishment>>	activePunishments(PunishmentType type, int page, int pageSize)	All currently-active bans/mutes, for /banlist.
CompletableFuture<Punishment>	ban(UUID target, @Nullable UUID issuedBy, String reason, @Nullable Long durationMillis)
CompletableFuture<Punishment>	banIp(String ip, @Nullable UUID issuedBy, String reason, @Nullable Long durationMillis)
CompletableFuture<List<Punishment>>	history(UUID target)	Full punishment history for a player, newest first.
CompletableFuture<Boolean>	isBanned(UUID target)
CompletableFuture<Boolean>	isIpBanned(String ip)
CompletableFuture<Boolean>	isMuted(UUID target)
CompletableFuture<Punishment>	kick(UUID target, @Nullable UUID issuedBy, String reason)	Kicks are instantaneous (no active state) but are still logged for /checkpunish.
CompletableFuture<Punishment>	mute(UUID target, @Nullable UUID issuedBy, String reason, @Nullable Long durationMillis)
CompletableFuture<Boolean>	unban(UUID target, @Nullable UUID revokedBy)
CompletableFuture<Boolean>	unbanIp(String ip, @Nullable UUID revokedBy)
CompletableFuture<Boolean>	unmute(UUID target, @Nullable UUID revokedBy)
CompletableFuture<Punishment>	warn(UUID target, @Nullable UUID issuedBy, String reason)

Method Details

ban

CompletableFuture<Punishment> ban(UUID target,
 @Nullable
 @Nullable UUID issuedBy,
 String reason,
 @Nullable
 @Nullable Long durationMillis)

banIp

CompletableFuture<Punishment> banIp(String ip,
 @Nullable
 @Nullable UUID issuedBy,
 String reason,
 @Nullable
 @Nullable Long durationMillis)

mute

CompletableFuture<Punishment> mute(UUID target,
 @Nullable
 @Nullable UUID issuedBy,
 String reason,
 @Nullable
 @Nullable Long durationMillis)

warn

CompletableFuture<Punishment> warn(UUID target,
 @Nullable
 @Nullable UUID issuedBy,
 String reason)

kick

CompletableFuture<Punishment> kick(UUID target,
 @Nullable
 @Nullable UUID issuedBy,
 String reason)

Kicks are instantaneous (no active state) but are still logged for /checkpunish.

unban

CompletableFuture<Boolean> unban(UUID target,
 @Nullable
 @Nullable UUID revokedBy)

unbanIp

CompletableFuture<Boolean> unbanIp(String ip,
 @Nullable
 @Nullable UUID revokedBy)

unmute

CompletableFuture<Boolean> unmute(UUID target,
 @Nullable
 @Nullable UUID revokedBy)

isBanned

CompletableFuture<Boolean> isBanned(UUID target)

isIpBanned

CompletableFuture<Boolean> isIpBanned(String ip)

isMuted

CompletableFuture<Boolean> isMuted(UUID target)

activeBan

CompletableFuture<@Nullable Punishment> activeBan(UUID target)

activeMute

CompletableFuture<@Nullable Punishment> activeMute(UUID target)

activeIpBan

CompletableFuture<@Nullable Punishment> activeIpBan(String ip)

history

CompletableFuture<List<Punishment>> history(UUID target)

Full punishment history for a player, newest first.

activePunishments

CompletableFuture<List<Punishment>> activePunishments(PunishmentType type,
 int page,
 int pageSize)

All currently-active bans/mutes, for /banlist.