Package live.crowdcontrol.cc4j.websocket.data

Class CCEffectResponse

java.lang.Object

live.crowdcontrol.cc4j.websocket.data.CCEffectResponse

Direct Known Subclasses:

CCInstantEffectResponse, CCTimedEffectResponse

public abstract class CCEffectResponse
extends Object

Informs the server of whether a purchased effect was executed successfully or not.

See Also:

• CCInstantEffectResponse
• CCTimedEffectResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull UUID	id
protected final @NotNull String	message
protected final @NotNull UUID	request
protected final int	stamp
protected final @NotNull ResponseStatus	status

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CCEffectResponse(@NotNull UUID requestID, @NotNull ResponseStatus status, @NotNull String message)	Creates a response.

Method Summary

Modifier and Type	Method	Description
@NotNull UUID	getId()	Gets the randomly generated ID of the argument.
@NotNull String	getMessage()	Gets the message to be displayed to the viewer about the status.
@NotNull UUID	getRequestId()	Gets the ID of the request that this result is in response to.
@NotNull ResponseStatus	getStatus()	The status value of the result.
int	getTimestamp()	Gets the timestamp in seconds since Unix epoch that this result was generated.

Methods inherited from class java.lang.Object

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

Field Details

id

@NotNull
protected final @NotNull UUID id

stamp

protected final int stamp

request

@NotNull
protected final @NotNull UUID request

message

@NotNull
protected final @NotNull String message

status

@NotNull
protected final @NotNull ResponseStatus status

Constructor Details

CCEffectResponse

protected CCEffectResponse(@NotNull
 @NotNull UUID requestID,
 @NotNull
 @NotNull ResponseStatus status,
 @NotNull
 @NotNull String message)

Creates a response.

Parameters:

requestID - the ID of the request

status - the status of the request

message - the reasoning to display to the viewer

Method Details

getId

@NotNull
public @NotNull UUID getId()

Gets the randomly generated ID of the argument.

Returns:

arg ID

getRequestId

@NotNull
public @NotNull UUID getRequestId()

Gets the ID of the request that this result is in response to.

Returns:

request ID

getTimestamp

public int getTimestamp()

Gets the timestamp in seconds since Unix epoch that this result was generated.

Returns:

unix epoch seconds timestamp

getMessage

@NotNull
public @NotNull String getMessage()

Gets the message to be displayed to the viewer about the status. May not be displayed if the status is successful. String may be empty if nothing is to be displayed.

Returns:

message

getStatus

@NotNull
public @NotNull ResponseStatus getStatus()

The status value of the result.

Returns:

result status