PolarDocs Client Area

UserCancellableCheckEvent Class

Introduction#

The UserCancellableCheckEvent class is used for events that can be cancelled and also involve users and checks.

Methods#

This class extends UserCancellableEvent and inherits all its methods.

Getter check#

java
Check check();

Returns:

The Check associated with the event.

Setter chatAlertMessage#

java
void chatAlertMessage(String chatAlertMessage);

Description:

Changes the message in the chat alert.

Parameters:

  • chatAlertMessage - The new alert message

Returns:

Nothing.

Getter chatAlertMessage#

java
String chatAlertMessage();

Returns:

A string containing the chat alert message.

Setter details#

java
void details(String details);

Description:

Changes the check debug details.

Parameters:

  • details - The updated check details

Returns:

Nothing.

Getter details#

java
String details();

Returns:

Details about this detection, such as movement or reach debugs.

Setter actionCommand#

java
void actionCommand(String actionCommand);

Description:

Changes the command that is executed when the chat alert is clicked.

Parameters:

  • actionCommand - The new action command

Returns:

Nothing.

Getter actionCommand#

java
String actionCommand();

Returns:

Command executed on click of the detection alert message.