Package live.crowdcontrol.cc4j.websocket.data

Class CCTimedEffectResponse

java.lang.Object

live.crowdcontrol.cc4j.websocket.data.CCEffectResponse

live.crowdcontrol.cc4j.websocket.data.CCTimedEffectResponse

public class CCTimedEffectResponse
extends CCEffectResponse

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

Field Summary

Fields

Modifier and Type	Field	Description
protected long	timeRemaining

Fields inherited from class live.crowdcontrol.cc4j.websocket.data.CCEffectResponse

id, message, request, stamp, status

Constructor Summary

Constructors

Constructor	Description
CCTimedEffectResponse(@NotNull UUID requestID, @NotNull ResponseStatus status, long timeRemaining)	Creates a response.
CCTimedEffectResponse(@NotNull UUID requestID, @NotNull ResponseStatus status, @NotNull String message, long timeRemaining)	Creates a response.

Method Summary

Modifier and Type	Method	Description
long	getTimeRemaining()	Gets the time remaining on the effect in milliseconds.

Methods inherited from class live.crowdcontrol.cc4j.websocket.data.CCEffectResponse

getId, getMessage, getRequestId, getStatus, getTimestamp

Methods inherited from class java.lang.Object

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

Field Details

timeRemaining

protected long timeRemaining

Constructor Details

CCTimedEffectResponse

public CCTimedEffectResponse(@NotNull
 @NotNull UUID requestID,
 @NotNull
 @NotNull ResponseStatus status,
 @NotNull
 @NotNull String message,
 long timeRemaining)

Creates a response.

Parameters:

requestID - the ID of the request

status - the status of the request

message - the reasoning to display to the viewer

timeRemaining - the time remaining on the effect in milliseconds

CCTimedEffectResponse

public CCTimedEffectResponse(@NotNull
 @NotNull UUID requestID,
 @NotNull
 @NotNull ResponseStatus status,
 long timeRemaining)

Creates a response.

Parameters:

requestID - the ID of the request

status - the status of the request

timeRemaining - the time remaining on the effect in milliseconds

Method Details

getTimeRemaining

public long getTimeRemaining()

Gets the time remaining on the effect in milliseconds.

Returns:

milliseconds