Package live.crowdcontrol.cc4j

Class CCEventType<T>

java.lang.Object

live.crowdcontrol.cc4j.CCEventType<T>

public class CCEventType<T>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final CCEventType<Void>	AUTH_EXPIRED	Called when a player's authentication token expires.
static final CCEventType<Void>	AUTHENTICATED	Called when a player's WebSocket becomes authenticated.
static final CCEventType<Void>	CONNECTED	Called when a player's WebSocket initially establishes its connection.
static final CCEventType<CloseData>	DISCONNECTED	Called when a player's WebSocket is closed.
static final CCEventType<PublicEffectPayload>	EFFECT_FAILURE
static final CCEventType<PublicEffectPayload>	EFFECT_REQUEST	Called when an effect-request comes in from the player.
static final CCEventType<CCEffectResponse>	EFFECT_RESPONSE	Called when CCPlayer.sendResponse(CCEffectResponse) has been called.
static final CCEventType<ApplicationAuthCodeErrorPayload>	ERRORED_AUTH_CODE	Called when an auth code has an error.
static final CCEventType<ApplicationAuthCodePayload>	GENERATED_AUTH_CODE	Called when an auth code is generated.
static final CCEventType<CCMessage>	MESSAGE	Called when a notification message may be displayed to the player.
static final CCEventType<ApplicationAuthCodeRedeemedPayload>	REDEEMED_AUTH_CODE	Called when an auth code is redeemed.
static final CCEventType<GameSessionStartPayload>	SESSION_STARTED	Called when a session has started.
static final CCEventType<GameSessionStopPayload>	SESSION_STOPPED	Called when a session has stopped.
static final CCEventType<SubscriptionResultPayload>	SUBSCRIBED	Called when a connection has attempted to subscribe to some topics.
static final CCEventType<Void>	UNAUTHENTICATED	Called when a player's auth token is removed for any reason.

Constructor Summary

Constructors

Constructor	Description
CCEventType(@NotNull String listenerId, @NotNull io.leangen.geantyref.TypeToken<T> typeToken)
CCEventType(@NotNull String listenerId, @NotNull Class<T> clazz)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NotNull String	getListenerId()
@NotNull io.leangen.geantyref.TypeToken<T>	getTypeToken()
int	hashCode()
static CCEventType<Void>	ofVoid(@NotNull String listenerId)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MESSAGE

public static final CCEventType<CCMessage> MESSAGE

Called when a notification message may be displayed to the player.

CONNECTED

public static final CCEventType<Void> CONNECTED

Called when a player's WebSocket initially establishes its connection. The connectionID will be unavailable at this point.

DISCONNECTED

public static final CCEventType<CloseData> DISCONNECTED

Called when a player's WebSocket is closed.

GENERATED_AUTH_CODE

public static final CCEventType<ApplicationAuthCodePayload> GENERATED_AUTH_CODE

Called when an auth code is generated.

REDEEMED_AUTH_CODE

public static final CCEventType<ApplicationAuthCodeRedeemedPayload> REDEEMED_AUTH_CODE

Called when an auth code is redeemed.

ERRORED_AUTH_CODE

public static final CCEventType<ApplicationAuthCodeErrorPayload> ERRORED_AUTH_CODE

Called when an auth code has an error.

AUTHENTICATED

public static final CCEventType<Void> AUTHENTICATED

Called when a player's WebSocket becomes authenticated. The connectionID may be unavailable at this point.

AUTH_EXPIRED

public static final CCEventType<Void> AUTH_EXPIRED

Called when a player's authentication token expires. This will happen 24 hours after creation.

UNAUTHENTICATED

public static final CCEventType<Void> UNAUTHENTICATED

Called when a player's auth token is removed for any reason. Shares overlap with AUTH_EXPIRED.

EFFECT_REQUEST

public static final CCEventType<PublicEffectPayload> EFFECT_REQUEST

Called when an effect-request comes in from the player. Note that the traditional way to receive this information is via CCEffect.onTrigger(PublicEffectPayload, CCPlayer).

EFFECT_FAILURE

public static final CCEventType<PublicEffectPayload> EFFECT_FAILURE

SUBSCRIBED

public static final CCEventType<SubscriptionResultPayload> SUBSCRIBED

Called when a connection has attempted to subscribe to some topics.

EFFECT_RESPONSE

public static final CCEventType<CCEffectResponse> EFFECT_RESPONSE

Called when CCPlayer.sendResponse(CCEffectResponse) has been called.

SESSION_STARTED

public static final CCEventType<GameSessionStartPayload> SESSION_STARTED

Called when a session has started.

SESSION_STOPPED

public static final CCEventType<GameSessionStopPayload> SESSION_STOPPED

Called when a session has stopped.

Constructor Details

CCEventType

public CCEventType(@NotNull
 @NotNull String listenerId,
 @NotNull
 @NotNull io.leangen.geantyref.TypeToken<T> typeToken)

CCEventType

public CCEventType(@NotNull
 @NotNull String listenerId,
 @NotNull
 @NotNull Class<T> clazz)

Method Details

ofVoid

public static CCEventType<Void> ofVoid(@NotNull
 @NotNull String listenerId)

getListenerId

@NotNull
public @NotNull String getListenerId()

getTypeToken

@NotNull
public @NotNull io.leangen.geantyref.TypeToken<T> getTypeToken()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object