Index (Crowd Control POJOs 3.7.1 API)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages

A

addArguments(Object...) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Adds arguments to be passed to the remote function.
addArguments(Collection<Object>) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Adds arguments to be passed to the remote function.
addConnectListener(Consumer<SocketManager>) - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Sets a consumer to be called when a new Crowd Control instance connects.
arguments() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the arguments to be passed to the remote function.
avatar() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Gets the URL of the recipient's avatar.
avatar(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Sets the URL of the recipient's avatar.

B

blocks() - Method in class dev.qixils.crowdcontrol.TimedEffect: Whether this effect blocks other effects from being executed (provided those other effects are in the same effect group and waits for others).
blocks() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets whether this effect blocks other effects from being executed (provided those other effects are in the same effect group and waits for others).
blocks(boolean) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets this effect blocks other effects from being executed (provided those other effects are in the same effect group and waits for others).
build() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Builds a new Request object.
build() - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Builds a new Request.Source object.
build() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Builds a new Request.Target object.
build() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Builds a new Response object.
build() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Builds a new timed effect.
Builder() - Constructor for class dev.qixils.crowdcontrol.socket.Request.Builder: Creates a new builder.
Builder() - Constructor for class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Creates a new builder.
Builder() - Constructor for class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Creates a new builder.
Builder() - Constructor for class dev.qixils.crowdcontrol.socket.Response.Builder: Creates a new empty builder.
Builder() - Constructor for class dev.qixils.crowdcontrol.TimedEffect.Builder: Creates a new TimedEffect.Builder.
Builder(Request) - Constructor for class dev.qixils.crowdcontrol.socket.Response.Builder: Creates a new builder representing the Response to a Request.
Builder(Response) - Constructor for class dev.qixils.crowdcontrol.socket.Response.Builder: Creates a new builder using the data from a Response.
Builder(Response.Builder) - Constructor for class dev.qixils.crowdcontrol.socket.Response.Builder: Creates a copy of the provided builder.
buildResponse() - Method in class dev.qixils.crowdcontrol.socket.Request: Creates a Builder for a Response to this request.
buildResponse() - Method in interface dev.qixils.crowdcontrol.socket.Respondable: Creates a Response builder.
buildResponse() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Creates a Response builder which will be dispatched to the connected server or clients upon calling Response.send().
ByteObject - Interface in dev.qixils.crowdcontrol.socket: An object that is represented by a byte in JSON serialization.

C

CATEGORY - dev.qixils.crowdcontrol.socket.IdType: A category of effects.
ccUID() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Gets the Crowd Control user ID of the recipient.
ccUID(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Sets the Crowd Control user ID of the recipient.
clone() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Creates a new builder object with the same parameters.
clone() - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Creates a new builder object with the same parameters.
clone() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Creates a new builder object with the same parameters.
clone() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Creates a new Response.Builder object with the same parameters.
clone() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Creates a cloned copy of this builder.
complete() - Method in class dev.qixils.crowdcontrol.TimedEffect: Marks the effect as completed and executes the completion callback.
complete(boolean) - Method in class dev.qixils.crowdcontrol.TimedEffect: Marks the effect as completed and optionally executes the completion callback.
completionCallback() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets the callback that will be executed if and when the effect completes.
completionCallback(Consumer<TimedEffect>) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the callback that will be executed if and when the effect completes.
cost() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the cost of the effect.
cost(Integer) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the cost of the effect.
create(Gson, TypeToken<T>) - Method in class dev.qixils.crowdcontrol.util.PostProcessor
CrowdControlException - Exception in dev.qixils.crowdcontrol.exceptions: A generic exception raised by a Crowd Control library or a package that using one.
CrowdControlException() - Constructor for exception dev.qixils.crowdcontrol.exceptions.CrowdControlException: Constructs a new exception with null as its detail message.
CrowdControlException(String) - Constructor for exception dev.qixils.crowdcontrol.exceptions.CrowdControlException: Constructs a new exception with the specified detail message.
CrowdControlException(String, Throwable) - Constructor for exception dev.qixils.crowdcontrol.exceptions.CrowdControlException: Constructs a new exception with the specified detail message and cause.
CrowdControlException(Throwable) - Constructor for exception dev.qixils.crowdcontrol.exceptions.CrowdControlException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

D

data() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the data to be passed in this event.
dev.qixils.crowdcontrol - package dev.qixils.crowdcontrol: Provides various common interfaces or implementation-agnostic clients for working with the Crowd Control SDK.
dev.qixils.crowdcontrol.exceptions - package dev.qixils.crowdcontrol.exceptions: Exceptions that may be thrown by the library or its users.
dev.qixils.crowdcontrol.socket - package dev.qixils.crowdcontrol.socket: Provides classes related to network communication, such as Request and Response.
dev.qixils.crowdcontrol.util - package dev.qixils.crowdcontrol.util
DISCONNECT - dev.qixils.crowdcontrol.socket.Response.PacketType: Internal value used to indicate that the socket is being disconnected.
duration() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the duration of the effect.
duration() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets the duration of this effect.
duration(long) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the duration of this effect.
duration(TemporalUnit, long) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the duration of this effect.
duration(TimeUnit, long) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the duration of this effect.
duration(Duration) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the duration of the effect.
duration(Duration) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the duration of this effect.

E

effect() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the effect being requested.
effect(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the effect being requested.
effect(String) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Deprecated.
Replaced by Response.Builder.ids(String...).
EFFECT - dev.qixils.crowdcontrol.socket.IdType: An effect.
EFFECT_RESULT - dev.qixils.crowdcontrol.socket.Response.PacketType: The packet is the result of executing an effect.
EFFECT_STATUS - dev.qixils.crowdcontrol.socket.Response.PacketType: The packet is updating the status of effects.
effectGroup() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets the effect group which this effect will be queued in.
effectGroup(String) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the effect group which this effect will be queued in.
encryptPassword(String) - Static method in interface dev.qixils.crowdcontrol.ServiceManager: Encrypts a password using the SHA-512 algorithm.
encryptPassword(String, String) - Static method in interface dev.qixils.crowdcontrol.ServiceManager: Encrypts a password using the specified algorithm.
equals(Object) - Method in class dev.qixils.crowdcontrol.socket.Request
equals(Object) - Method in class dev.qixils.crowdcontrol.socket.Request.Target
equals(Object) - Method in class dev.qixils.crowdcontrol.socket.Response
equals(Object) - Method in class dev.qixils.crowdcontrol.socket.Request.Source
equalsRoughly(Object) - Method in class dev.qixils.crowdcontrol.socket.Request.Target: Determines if the provided object is roughly equal to this Request.Target.
eventType() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the type of event being fired.
eventType(String) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the type of event being fired.
ExceptionUtil - Class in dev.qixils.crowdcontrol.exceptions: Utility class containing common methods relating to exceptions.

F

FAILURE - dev.qixils.crowdcontrol.socket.Response.ResultType: The effect failed to be applied.
FALSE - dev.qixils.crowdcontrol.TriState: The value is false.
FINISHED - dev.qixils.crowdcontrol.socket.Response.ResultType: The timed effect has finished.
from(byte) - Static method in enum dev.qixils.crowdcontrol.socket.IdType: Gets an ID type from its corresponding JSON encoding.
from(byte) - Static method in enum dev.qixils.crowdcontrol.socket.Request.Type: Gets a packet type from its corresponding JSON encoding.
from(byte) - Static method in enum dev.qixils.crowdcontrol.socket.Response.PacketType: Gets a packet type from its corresponding JSON encoding.
from(byte) - Static method in enum dev.qixils.crowdcontrol.socket.Response.ResultType: Gets a packet type from its corresponding JSON encoding.
fromBoolean(Boolean) - Static method in enum dev.qixils.crowdcontrol.TriState: Returns the TriState equivalent of the given Boolean.
fromInputStream(InputStream, Function<String, T>) - Static method in interface dev.qixils.crowdcontrol.socket.JsonObject: Obtains a JSON object from an input stream of 0x00-terminated json strings.
fromJSON(String) - Static method in class dev.qixils.crowdcontrol.socket.Request: Creates a Request object from JSON.
fromJSON(String) - Static method in class dev.qixils.crowdcontrol.socket.Response: Creates a Response object from JSON.

G

GENERIC_EVENT - dev.qixils.crowdcontrol.socket.Response.PacketType: The packet is a generic event.
getArguments() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets a copy of the arguments to be passed to the remote function.
getAvatar() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: Gets the URL of the recipient's avatar.
getBoolean() - Method in enum dev.qixils.crowdcontrol.TriState: Returns the Boolean equivalent of this TriState.
getCCUID() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: Gets the Crowd Control user ID of the recipient.
getConnections() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Returns an unmodifiable collection of the individual connected SocketManagers represented by this SocketManager.
getCost() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the cost of the effect specified in this Request.
getCurrentDuration() - Method in class dev.qixils.crowdcontrol.TimedEffect: Returns the current time remaining in the effect.
getData() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets a view of the event data.
getDisplayName() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Gets a unique display name for this SocketManager.
getDuration() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the streamer-specified duration of this effect.
getEffect() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the name of the effect to play.
getEffectGroup() - Method in class dev.qixils.crowdcontrol.TimedEffect: Gets the effect group which this effect will be queued in.
getEncodedByte() - Method in interface dev.qixils.crowdcontrol.socket.ByteObject: Gets the byte that this object is represented by in JSON serialization.
getEncodedByte() - Method in enum dev.qixils.crowdcontrol.socket.IdType
getEncodedByte() - Method in enum dev.qixils.crowdcontrol.socket.Request.Type
getEncodedByte() - Method in enum dev.qixils.crowdcontrol.socket.Response.PacketType
getEncodedByte() - Method in enum dev.qixils.crowdcontrol.socket.Response.ResultType
getEventType() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the name of the event being fired.
getId() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the ID of the incoming packet.
getId() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: The recipient's ID.
getId() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the ID of the outgoing packet.
getIds() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the IDs receiving a status update.
getIdType() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the type of effect receiving a status update.
getIP() - Method in interface dev.qixils.crowdcontrol.ServiceManager: Returns the IP that the SocketManager will listen on.
getLogin() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the name or ID of the streamer in the game.
getLogin() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: The recipient's username.
getMessage() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the message from the incoming packet.
getMessage() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the message that will be delivered along with the result.
getMethod() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the name of the remote function to be executed.
getName() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: The recipient's display name.
getOriginalDuration() - Method in class dev.qixils.crowdcontrol.TimedEffect: Gets the duration of that was set on construction.
getOriginatingSocket() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the Socket that this Request originated from.
getPacketType() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the type of packet represented by this response.
getParameters() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the miscellaneous parameters for this effect.
getPassword() - Method in interface dev.qixils.crowdcontrol.ServiceManager: Returns the password required for clients to connect to this server as a SHA-512 encrypted, Base64-encoded string.
getPassword() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the submitted password.
getPlayer() - Method in class dev.qixils.crowdcontrol.socket.Request: If this is a Request.Type.PLAYER_INFO packet, gets the player's info.
getPort() - Method in interface dev.qixils.crowdcontrol.ServiceManager: Returns the port that the SocketManager will listen on.
getPrimitiveBoolean() - Method in enum dev.qixils.crowdcontrol.TriState: Returns the primitive boolean equivalent of this TriState.
getQuantity() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the quantity of the item to be added or removed.
getQuantityOrDefault() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the quantity of the item to be added or removed.
getRequest() - Method in class dev.qixils.crowdcontrol.TimedEffect: Gets the request that this timed effect corresponds to.
getResultType() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the result of executing an effect.
getService() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: Gets the service that the streamer is streaming on.
getSource() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the streamer that this Request originated from.
getSource() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Gets the Request.Source that this SocketManager is connected to if there is only one.
getSources() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Gets the Request.Sources that this SocketManager is connected to.
getTargets() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the streamers being targeted by this effect.
getTimeRemaining() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the time left until the referenced effect ends.
getType() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the Type of the request.
getValue() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the value returned by the remote function.
getViewer() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the name of the viewer who triggered the effect.
GROUP - dev.qixils.crowdcontrol.socket.IdType: A group of effects.

H

handle(Request) - Method in interface dev.qixils.crowdcontrol.RequestManager: Handles an incoming request by dispatching it to the appropriate effect handler.
hashCode() - Method in class dev.qixils.crowdcontrol.socket.Request
hashCode() - Method in class dev.qixils.crowdcontrol.socket.Request.Source
hashCode() - Method in class dev.qixils.crowdcontrol.socket.Request.Target
hashCode() - Method in class dev.qixils.crowdcontrol.socket.Response
hasResultType() - Method in enum dev.qixils.crowdcontrol.socket.Response.PacketType: Determines if this packet type requires an accompanying Response.ResultType to be sent.
hasStarted() - Method in class dev.qixils.crowdcontrol.TimedEffect: Determines if this effect has started.

I

id() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the ID of the request.
id() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Gets the recipient's ID.
id() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the ID of the Request that prompted this Response.
id(int) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the ID of the request.
id(int) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the ID of the Request that prompted this Response.
id(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Sets the recipient's ID.
ids() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the effects whose status is being reported on.
ids(Iterable<String>) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Adds effects whose status is being reported on.
ids(String...) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Adds effects whose status is being reported on.
idType() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the type of ID whose status is being reported on.
idType(IdType) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the type of ID which is being reported on.
IdType - Enum in dev.qixils.crowdcontrol.socket: A type of effect identifier.
internal() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets whether the packet is internal.
internal(Boolean) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets whether the packet is internal.
ip() - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Gets the IP address of this source.
ip() - Method in class dev.qixils.crowdcontrol.socket.Request.Source: The IP address of this source.
ip(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Sets the IP address of this source.
ip(InetAddress) - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Sets the IP address of this source.
isActive(Request) - Static method in class dev.qixils.crowdcontrol.TimedEffect: Determines if the given Request is active for any targeted streamer.
isActive(String, Request) - Static method in class dev.qixils.crowdcontrol.TimedEffect: Determines if a blocking effect with the provided name is currently active for any streamer targeted by the provided Request.
isActive(String, Request.Target...) - Static method in class dev.qixils.crowdcontrol.TimedEffect: Determines if a blocking effect with the provided name is currently active for any of the provided streamers.
isCause(Class<? extends Throwable>, Throwable) - Static method in class dev.qixils.crowdcontrol.exceptions.ExceptionUtil: Helper method for determining if a provided exception class is part of an exception's stacktrace.
isClosed() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Determines whether this socket is closed.
isComplete() - Method in class dev.qixils.crowdcontrol.TimedEffect: Determines if this effect has completed.
isEffectType() - Method in enum dev.qixils.crowdcontrol.socket.Request.Type: Determines if this packet represents a standard effect request.
isGlobal() - Method in class dev.qixils.crowdcontrol.socket.Request: Determines if this Request is triggering an effect for all users.
isInternal() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets whether this packet is internal.
isMessageRequired() - Method in enum dev.qixils.crowdcontrol.socket.Response.PacketType: Determines if this packet type requires an accompanying message to be sent.
isOriginKnown() - Method in class dev.qixils.crowdcontrol.socket.Response: Determines if the Request that originated this Response is known.
isPaused() - Method in class dev.qixils.crowdcontrol.TimedEffect: Determines if the effect is paused.
isStatus() - Method in enum dev.qixils.crowdcontrol.socket.Response.ResultType: Determines if this result type must be used in combination with Response.PacketType.EFFECT_STATUS and an effect ID of 0.
isTerminating() - Method in class dev.qixils.crowdcontrol.socket.Response: Determines if this Response marks the end to a series of responses to a Request.
isTerminating() - Method in enum dev.qixils.crowdcontrol.socket.Response.ResultType: Determines if this result type always marks the end to a series of Responses to a Request.

J

JsonObject - Interface in dev.qixils.crowdcontrol.socket: An object that can be serialized into JSON.

K

KEEP_ALIVE - dev.qixils.crowdcontrol.socket.Request.Type: This packet's sole purpose is to establish that the connection with the Crowd Control server has not been dropped.
KEEP_ALIVE - dev.qixils.crowdcontrol.socket.Response.PacketType: Internal value used to reply to a keep alive packet.

L

login() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the name or ID of the streamer in the game.
login() - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Gets the name or ID of the streamer in the game.
login() - Method in class dev.qixils.crowdcontrol.socket.Request.Source: The name or ID of the streamer in the game.
login() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Gets the recipient's username.
login(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the name or ID of the streamer in the game.
login(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Sets the name or ID of the streamer in the game.
login(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Sets the recipient's username.
LOGIN - dev.qixils.crowdcontrol.socket.Request.Type: Indicates that a streamer is attempting to log in to the Crowd Control server.
LOGIN - dev.qixils.crowdcontrol.socket.Response.PacketType: Internal value used to prompt a connecting client for a password.
LOGIN_SUCCESS - dev.qixils.crowdcontrol.socket.Response.PacketType: Internal value used to indicate a successful login.

M

message() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the message describing or explaining the request.
message() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the message describing or explaining the response.
message(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the message describing or explaining the request.
message(String) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the message describing or explaining the response.
method() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the name of the remote function to be called.
method(String) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the name of the remote function to be called.

N

name() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Gets the recipient's display name.
name(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Sets the recipient's display name.
NoApplicableTarget - Exception in dev.qixils.crowdcontrol.exceptions: An exception indicating that a software utilizing the Crowd Control receiver library was unable to map the provided target(s) while attempting to execute an effect and that the library should retry the effect after a short time.
NoApplicableTarget() - Constructor for exception dev.qixils.crowdcontrol.exceptions.NoApplicableTarget: Constructs a new exception with null as its detail message.
NoApplicableTarget(String) - Constructor for exception dev.qixils.crowdcontrol.exceptions.NoApplicableTarget: Constructs a new exception with the specified detail message.
NoApplicableTarget(String, Throwable) - Constructor for exception dev.qixils.crowdcontrol.exceptions.NoApplicableTarget: Constructs a new exception with the specified detail message and cause.
NoApplicableTarget(Throwable) - Constructor for exception dev.qixils.crowdcontrol.exceptions.NoApplicableTarget: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
NOT_READY - dev.qixils.crowdcontrol.socket.Response.ResultType: Indicates that this Crowd Control server is not yet accepting requests.
NOT_SELECTABLE - dev.qixils.crowdcontrol.socket.Response.ResultType: Instructs the client to make this effect in its menu unselectable.
NOT_VISIBLE - dev.qixils.crowdcontrol.socket.Response.ResultType: Instructs the client to hide this effect in its menu.

O

originatingSocket() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the originating socket of the request.
originatingSocket() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the Socket of the Request that prompted this Response.
originatingSocket(SocketManager) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the originating socket of the request.
originatingSocket(SocketManager) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the Socket of the Request that prompted this Response.

P

packetType() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the type of packet that this Response represents.
packetType(Response.PacketType) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the type of packet that this Response represents.
parameters() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the parameters of the effect.
parameters(Object...) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the parameters of the effect.
password() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the submitted password.
password(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the submitted password.
pause() - Method in class dev.qixils.crowdcontrol.TimedEffect: Indicates that the effect has paused execution.
pauseAll() - Static method in class dev.qixils.crowdcontrol.TimedEffect: Pauses all active effects.
pauseCallback() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets the callback that will be executed if and when the effect is paused.
pauseCallback(Consumer<TimedEffect>) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the callback that will be executed when the effect is paused.
PAUSED - dev.qixils.crowdcontrol.socket.Response.ResultType: The timed effect has been paused and is now waiting.
player() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the Request.Type.PLAYER_INFO data.
player(Request.Target) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the Request.Type.PLAYER_INFO data.
PLAYER_INFO - dev.qixils.crowdcontrol.socket.Request.Type: Identifies the connected player.
postProcess() - Method in class dev.qixils.crowdcontrol.socket.Request.Target
postProcess() - Method in interface dev.qixils.crowdcontrol.util.PostProcessable: Post-processes this object.
PostProcessable - Interface in dev.qixils.crowdcontrol.util: An object that can be post-processed after GSON deserialization.
PostProcessor - Class in dev.qixils.crowdcontrol.util
PostProcessor() - Constructor for class dev.qixils.crowdcontrol.util.PostProcessor
putData(String, Object) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Adds data to be passed in this event.

Q

quantity() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the quantity of the item to be added or removed.
quantity(Integer) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the quantity of the item to be added or removed.
queue() - Method in class dev.qixils.crowdcontrol.TimedEffect: Queues this effect for execution.

R

REMOTE_FUNCTION - dev.qixils.crowdcontrol.socket.Response.PacketType: The packet is triggering a remote function to be run in the CS.
REMOTE_FUNCTION_RESULT - dev.qixils.crowdcontrol.socket.Request.Type: Indicates the result of a Response.PacketType.REMOTE_FUNCTION.
repr(String) - Static method in class dev.qixils.crowdcontrol.util.StringUtils: Returns a string representation of the given string.
request() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets the request that caused this timed effect to be created.
request(Request) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the request that this timed effect corresponds to.
Request - Class in dev.qixils.crowdcontrol.socket: An incoming packet from the Crowd Control TCP server which represents an effect to be played.
Request.Builder - Class in dev.qixils.crowdcontrol.socket: Mutable builder for the immutable Request class.
Request.Source - Class in dev.qixils.crowdcontrol.socket: The source of an effect.
Request.Source.Builder - Class in dev.qixils.crowdcontrol.socket: Mutable builder for the immutable Request.Source class.
Request.Target - Class in dev.qixils.crowdcontrol.socket: A recipient of an effect.
Request.Target.Builder - Class in dev.qixils.crowdcontrol.socket: Mutable builder for the immutable Request.Target class.
Request.Type - Enum in dev.qixils.crowdcontrol.socket: The type of incoming packet.
RequestManager - Interface in dev.qixils.crowdcontrol: A class that holds variables for a SocketManager and can process incoming data from the socket.
Respondable - Interface in dev.qixils.crowdcontrol.socket: Something that can be responded to.
Response - Class in dev.qixils.crowdcontrol.socket: An outgoing packet to the Crowd Control TCP server carrying the result of executing a requested effect.
Response.Builder - Class in dev.qixils.crowdcontrol.socket: Mutable builder for the immutable Response class.
Response.PacketType - Enum in dev.qixils.crowdcontrol.socket: Determines the type of packet being sent.
Response.ResultType - Enum in dev.qixils.crowdcontrol.socket: The result of processing an incoming packet.
resume() - Method in class dev.qixils.crowdcontrol.TimedEffect: Indicates that the effect has resumed execution.
resumeAll() - Static method in class dev.qixils.crowdcontrol.TimedEffect: Resumes all effects previously paused by TimedEffect.pauseAll().
resumeCallback() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets the callback that will be executed if and when the effect is resumed.
resumeCallback(Consumer<TimedEffect>) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the callback that will be executed when the effect is resumed.
RESUMED - dev.qixils.crowdcontrol.socket.Response.ResultType: The timed effect has been resumed and is counting down again.
RETRY - dev.qixils.crowdcontrol.socket.Response.ResultType: The effect is momentarily unavailable but may be retried in a few seconds.

S

SELECTABLE - dev.qixils.crowdcontrol.socket.Response.ResultType: Instructs the client to make this effect in its menu selectable.
send() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Builds this Response and then sends it to the client or server that delivered the related Request.
send() - Method in class dev.qixils.crowdcontrol.socket.Response: Sends this Response to the client or server that delivered the related Request.
service() - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Gets the service that the streamer is streaming on.
service(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Target.Builder: Sets the service that the streamer is streaming on.
ServiceManager - Interface in dev.qixils.crowdcontrol: Manager for Crowd Control-related clients or servers.
setOriginatingSocket(SocketManager) - Method in class dev.qixils.crowdcontrol.socket.Request: Sets the Socket that this Request originated from.
setSource(Request.Source) - Method in class dev.qixils.crowdcontrol.socket.Request: Sets the streamer that this Request originated from.
shutdown() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Deprecated.
providing error messages via SocketManager.shutdown(String) is recommended
shutdown(Request, String) - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Shuts down the Crowd Control socket and sends an explanation message to the streamer.
shutdown(String) - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Shuts down the Crowd Control socket and sends an explanation message to the streamer.
SocketManager - Interface in dev.qixils.crowdcontrol.socket: Manages the connection(s) to a Crowd Control server or clients.
source() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the streamer through which the effect was requested.
source(Request.Source) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the streamer through which the effect was requested.
START - dev.qixils.crowdcontrol.socket.Request.Type: Indicates that you should start an effect, if available.
startCallback() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets the callback that will be executed when the effect starts.
startCallback(Function<TimedEffect, Response.Builder>) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets the callback that will be executed when the effect starts.
STOP - dev.qixils.crowdcontrol.socket.Request.Type: Indicates that you should stop an effect.
StringUtils - Class in dev.qixils.crowdcontrol.util: Utilities for working with strings.
SUCCESS - dev.qixils.crowdcontrol.socket.Response.ResultType: The effect was applied successfully.

T

target() - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Gets the identity of this source.
target() - Method in class dev.qixils.crowdcontrol.socket.Request.Source: The identity of this source.
target(Request.Target) - Method in class dev.qixils.crowdcontrol.socket.Request.Source.Builder: Sets the identity of this source.
targets() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the targets of the effect.
targets(Request.Target...) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the targets of the effect.
TEST - dev.qixils.crowdcontrol.socket.Request.Type: Indicates that you should simulate the starting of an effect (i.e.
TimedEffect - Class in dev.qixils.crowdcontrol: A wrapper for safely executing exclusive timed effects.
TimedEffect.Builder - Class in dev.qixils.crowdcontrol: Builds a new TimedEffect, a wrapper for safely executing exclusive timed effects.
timeRemaining() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the time left on the referenced effect in milliseconds.
timeRemaining(long) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the time left on the referenced effect in milliseconds.
timeRemaining(long, TemporalUnit) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the time left on the referenced effect.
timeRemaining(long, TimeUnit) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the time left on the referenced effect.
timeRemaining(Duration) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the time left on the referenced effect.
timeRemaining(Temporal) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the time at which the referenced effect will end.
toBuilder() - Method in class dev.qixils.crowdcontrol.socket.Request.Source: Creates a builder with the same parameters as this object.
toBuilder() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: Creates a mutable Request.Target.Builder with a copy of the data in this Request.Target.
toBuilder() - Method in class dev.qixils.crowdcontrol.socket.Request: Creates a mutable Request.Builder with a copy of the data in this Request.
toBuilder() - Method in class dev.qixils.crowdcontrol.socket.Response: Creates a mutable Response.Builder with a copy of the data in this Response.
toBuilder() - Method in class dev.qixils.crowdcontrol.TimedEffect: Creates a mutable TimedEffect.Builder with a copy of the data in this TimedEffect.
toJSON() - Method in interface dev.qixils.crowdcontrol.socket.JsonObject: Converts this object to its JSON representation.
toJSON() - Method in class dev.qixils.crowdcontrol.socket.Request: Outputs this object as a JSON string.
toJSON() - Method in class dev.qixils.crowdcontrol.socket.Response: Outputs this object as a JSON string for use in the server connection.
toString() - Method in class dev.qixils.crowdcontrol.socket.Request.Source
toString() - Method in class dev.qixils.crowdcontrol.socket.Request.Target
toString() - Method in class dev.qixils.crowdcontrol.socket.Request
toString() - Method in class dev.qixils.crowdcontrol.socket.Response
TriState - Enum in dev.qixils.crowdcontrol: A boolean value that may be unknown.
TRUE - dev.qixils.crowdcontrol.TriState: The value is true.
type() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the type of result being returned.
type() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Gets the type of result being returned.
type(Request.Type) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the type of result being returned.
type(Response.ResultType) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the type of result being returned.

U

UNAVAILABLE - dev.qixils.crowdcontrol.socket.Response.ResultType: The requested effect is unusable and should not be requested again.
UNKNOWN - dev.qixils.crowdcontrol.TriState: The value is unknown.
usesIncrementalIds() - Method in enum dev.qixils.crowdcontrol.socket.Request.Type: Determines if this packet is expected to use incremental IDs.

V

validateNotNull(T) - Static method in class dev.qixils.crowdcontrol.exceptions.ExceptionUtil: Validates that the provided object is not null.
validateNotNull(T, String) - Static method in class dev.qixils.crowdcontrol.exceptions.ExceptionUtil: Validates that the provided object is not null.
validateNotNullElse(T, T) - Static method in class dev.qixils.crowdcontrol.exceptions.ExceptionUtil: Returns the first parameter if it is not null, else the second parameter.
validateNotNullElseGet(T, Supplier<T>) - Static method in class dev.qixils.crowdcontrol.exceptions.ExceptionUtil: Returns the first parameter if it is not null, else the object provided by the second parameter.
value() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the value returned by a remote function.
value(Object) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the value returned by a remote function.
valueOf(String) - Static method in enum dev.qixils.crowdcontrol.socket.IdType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.qixils.crowdcontrol.socket.Request.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.qixils.crowdcontrol.socket.Response.PacketType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.qixils.crowdcontrol.socket.Response.ResultType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.qixils.crowdcontrol.TriState: Returns the enum constant of this type with the specified name.
values() - Static method in enum dev.qixils.crowdcontrol.socket.IdType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.qixils.crowdcontrol.socket.Request.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.qixils.crowdcontrol.socket.Response.PacketType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.qixils.crowdcontrol.socket.Response.ResultType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.qixils.crowdcontrol.TriState: Returns an array containing the constants of this enum type, in the order they are declared.
viewer() - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Gets the viewer requesting the effect.
viewer(String) - Method in class dev.qixils.crowdcontrol.socket.Request.Builder: Sets the viewer requesting the effect.
VISIBLE - dev.qixils.crowdcontrol.socket.Response.ResultType: Instructs the client to display this effect in its menu.

W

waits() - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Gets whether this effect waits for other effects in the same effect group to complete.
waits() - Method in class dev.qixils.crowdcontrol.TimedEffect: Whether this effect waits for other effects in the same effect group to complete.
waits(boolean) - Method in class dev.qixils.crowdcontrol.TimedEffect.Builder: Sets whether this effect waits for other effects in the same effect group to complete.
write(Response) - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Writes a Response to the connected server or clients.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages