Package me.remigio07.chatplugin.api.server.chat.antispam

Class AntispamResult

java.lang.Object

me.remigio07.chatplugin.api.server.chat.antispam.AntispamResult

public abstract class AntispamResult
extends Object

Represents the result of AntispamManager.check(ChatPluginServerPlayer, String, List)

Constructor Summary

Constructors

Constructor	Description
AntispamResult()

Method Summary

Modifier and Type	Method	Description
String	getDisallowedText()	Gets the disallowed text in the message that triggered the antispam.
String	getHighlightedMessage()	Gets the message with highlighted disallowed text.
DenyChatReason<AntispamManager>	getReason()	Gets the reason why the message should be blocked.
boolean	isAllowed()	Checks if the message is allowed by the antispam.

Methods inherited from class java.lang.Object

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

Constructor Details

AntispamResult

public AntispamResult()

Method Details

getReason

public DenyChatReason<AntispamManager> getReason()

Gets the reason why the message should be blocked.

Will return null if isAllowed().

Returns:

Reason why the message should be blocked

getDisallowedText

public String getDisallowedText()

Gets the disallowed text in the message that triggered the antispam.

Will return null if isAllowed().

Returns:

Disallowed text in the message

getHighlightedMessage

public String getHighlightedMessage()

Gets the message with highlighted disallowed text.

Will return null if isAllowed().

Returns:

Message with highlighted disallowed text

isAllowed

public boolean isAllowed()

Checks if the message is allowed by the antispam.

Returns:

Whether the message is allowed