io.github.nucleuspowered.nucleus.api.module.mute.data

Interface Mute

All Superinterfaces:

TimedEntry

public interface Mute
extends TimedEntry

Provides information about a player's mute.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.time.Instant>	getCreationInstant() Gets the Instant this player was muted, if this information was recorded.
java.util.Optional<java.util.UUID>	getMuter() The UUID of the muter, or Optional.empty() if the muter was not a player.
java.lang.String	getReason() The reason for the mute.

Methods inherited from interface io.github.nucleuspowered.nucleus.api.util.data.TimedEntry

expired, getRemainingTime, isCurrentlyTicking

Method Detail

getReason

java.lang.String getReason()

The reason for the mute.

Returns:

The reason.

getMuter

java.util.Optional<java.util.UUID> getMuter()

The UUID of the muter, or Optional.empty() if the muter was not a player.

Returns:

The UUID of the muter, if applicable.

getCreationInstant

java.util.Optional<java.time.Instant> getCreationInstant()

Gets the Instant this player was muted, if this information was recorded.

Returns:

The instant, if known.

Since:

0.27