Index (java-crowd-control 3.2.1 API)

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

A

ALLOW - dev.qixils.crowdcontrol.CheckResult: Allows an effect to be executed, assuming all other checks return the same result.

B

build() - Method in interface dev.qixils.crowdcontrol.builder.CrowdControlBuilder: Builds a new CrowdControl instance using the provided variables.
build() - Method in class dev.qixils.crowdcontrol.builder.CrowdControlClientBuilder: Builds a new CrowdControl instance using the provided variables.
build() - Method in class dev.qixils.crowdcontrol.builder.CrowdControlServerBuilder: Builds a new CrowdControl instance using the provided variables.
build() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Builds a new Response object.
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.
buildResponse() - Method in class dev.qixils.crowdcontrol.socket.Request: Creates a Response.Builder for a Response to this request.
ByteObject - Interface in dev.qixils.crowdcontrol.socket: An object that is represented by a byte in JSON serialization.

C

CheckResult - Enum in dev.qixils.crowdcontrol: The value returned by a check.
client() - Static method in class dev.qixils.crowdcontrol.CrowdControl: Returns a builder for a new CrowdControl instance operating in client mode.
ClientSocketManager - Class in dev.qixils.crowdcontrol.socket: Manages the connection to the Crowd Control server.
ClientSocketManager(CrowdControl) - Constructor for class dev.qixils.crowdcontrol.socket.ClientSocketManager: Creates a new client-side socket manager.
clone() - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Creates a new Response.Builder object with the same parameters.
complete() - Method in class dev.qixils.crowdcontrol.TimedEffect: Marks the effect as completed.
CrowdControl - Class in dev.qixils.crowdcontrol: API for interacting with Crowd Control via the SimpleTCPConnector or SimpleTCPClientConnector.
CrowdControl(String, int, String, Function<CrowdControl, SocketManager>) - Constructor for class dev.qixils.crowdcontrol.CrowdControl: Creates a new Crowd Control client or server instance.
CrowdControlBuilder - Interface in dev.qixils.crowdcontrol.builder: Builds a new CrowdControl instance.
CrowdControlClientBuilder - Class in dev.qixils.crowdcontrol.builder: Builds a new CrowdControl instance that acts as a client and connects to a single Crowd Control server instance.
CrowdControlClientBuilder() - Constructor for class dev.qixils.crowdcontrol.builder.CrowdControlClientBuilder: Creates a new CrowdControl client builder.
CrowdControlException - Exception in dev.qixils.crowdcontrol.exceptions: A generic exception raised by CrowdControl or a package that uses it.
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).
CrowdControlServerBuilder - Class in dev.qixils.crowdcontrol.builder: Builds a new CrowdControl instance that acts as a server for Crowd Control clients to connect to.
CrowdControlServerBuilder() - Constructor for class dev.qixils.crowdcontrol.builder.CrowdControlServerBuilder: Creates a new CrowdControl server builder.

D

dev.qixils.crowdcontrol - package dev.qixils.crowdcontrol: Provides most of the basic classes required to implement CrowdControl into your project.
dev.qixils.crowdcontrol.builder - package dev.qixils.crowdcontrol.builder: Provides classes used to build CrowdControl.
dev.qixils.crowdcontrol.exceptions - package dev.qixils.crowdcontrol.exceptions: Exceptions that may be thrown by library users.
dev.qixils.crowdcontrol.socket - package dev.qixils.crowdcontrol.socket: Provides classes related to network communication, such as Request and Response.
DISALLOW - dev.qixils.crowdcontrol.CheckResult: Prevents an effect from being executed.

E

effect() - Method in annotation type dev.qixils.crowdcontrol.Subscribe: The name of the effect to listen to.
equals(Object) - Method in class dev.qixils.crowdcontrol.socket.Request.Target

F

FAILURE - dev.qixils.crowdcontrol.socket.Response.ResultType: The effect failed to be applied.
FINISHED - dev.qixils.crowdcontrol.socket.Response.ResultType: The timed effect has finished.
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.ResultType: Gets a packet type from its corresponding JSON encoding.
fromJSON(String) - Static method in class dev.qixils.crowdcontrol.socket.Request: Creates a Request object from JSON.

G

getAvatar() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: Gets the URL of the recipient's avatar on Twitch.
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 milliseconds remaining in the effect, or 0 if it should be complete.
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.Request.Type
getEncodedByte() - Method in enum dev.qixils.crowdcontrol.socket.Response.ResultType
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 Twitch ID.
getId() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the ID of the outgoing packet.
getIP() - Method in class dev.qixils.crowdcontrol.CrowdControl: Returns the IP that the SocketManager will listen on.
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.
getName() - Method in class dev.qixils.crowdcontrol.socket.Request.Target: The recipient's name on Twitch.
getParameters() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the arguments supplied by the C# Crowd Control pack
getPassword() - Method in class dev.qixils.crowdcontrol.CrowdControl: Returns the password required for clients to connect to this server as a SHA-512 encrypted, Base64-encoded string.
getPort() - Method in class dev.qixils.crowdcontrol.CrowdControl: Returns the port that the SocketManager will listen on.
getRequest() - Method in class dev.qixils.crowdcontrol.socket.Response: Gets the unique Request that caused this response.
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.
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 milliseconds left until the referenced effect ends.
getType() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the Type of the request.
getViewer() - Method in class dev.qixils.crowdcontrol.socket.Request: Gets the name of the viewer who triggered the effect.

H

handle(Request) - Method in class dev.qixils.crowdcontrol.CrowdControl: Handles an incoming Request by executing the relevant handler.
hashCode() - Method in class dev.qixils.crowdcontrol.socket.Request.Target
hasStarted() - Method in class dev.qixils.crowdcontrol.TimedEffect: Determines if this effect has started.

I

ip(String) - Method in class dev.qixils.crowdcontrol.builder.CrowdControlClientBuilder: Sets the IP that the Crowd Control client will connect to.
isActive(String, Request) - Static method in class dev.qixils.crowdcontrol.TimedEffect: Determines if an 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 an 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.CrowdControl: Helper method for determining if a provided exception class is part of an exception's stacktrace.
isComplete() - Method in class dev.qixils.crowdcontrol.TimedEffect: Determines if this effect has completed.
isGlobal() - Method in class dev.qixils.crowdcontrol.socket.Request: Determines if this Request is triggering an effect for all users.

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.

L

LOGIN - dev.qixils.crowdcontrol.socket.Request.Type: Indicates that a streamer is attempting to log in to the Crowd Control server.

M

message(String) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the message describing or explaining the response.

N

NoApplicableTarget - Exception in dev.qixils.crowdcontrol.exceptions: An exception indicating that a software utilizing the CrowdControl 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.

P

password(String) - Method in class dev.qixils.crowdcontrol.builder.CrowdControlServerBuilder: Sets the password required for Crowd Control clients to connect.
pause() - Method in class dev.qixils.crowdcontrol.TimedEffect: Indicates that the effect has paused execution.
PAUSED - dev.qixils.crowdcontrol.socket.Response.ResultType: The timed effect has been paused and is now waiting.
port(int) - Method in interface dev.qixils.crowdcontrol.builder.CrowdControlBuilder: Sets the port that will be used by the Crowd Control client or server.
port(int) - Method in class dev.qixils.crowdcontrol.builder.CrowdControlClientBuilder: Sets the port that will be used by the Crowd Control client.
port(int) - Method in class dev.qixils.crowdcontrol.builder.CrowdControlServerBuilder: Sets the port that will be used by the Crowd Control server.

Q

queue() - Method in class dev.qixils.crowdcontrol.TimedEffect: Queues this effect for execution.

R

registerCheck(Function<Request, CheckResult>) - Method in class dev.qixils.crowdcontrol.CrowdControl: Registers a check which will be called for every incoming Request.
registerCheck(Supplier<CheckResult>) - Method in class dev.qixils.crowdcontrol.CrowdControl: Registers a check which will be called for every incoming Request.
registerHandler(String, Consumer<Request>) - Method in class dev.qixils.crowdcontrol.CrowdControl: Registers an effect handler which does not immediately return a Response.
registerHandler(String, Function<Request, Response>) - Method in class dev.qixils.crowdcontrol.CrowdControl: Registers a function to handle an effect.
registerHandlers(Object) - Method in class dev.qixils.crowdcontrol.CrowdControl: Registers method handlers within a class.
Request - Class in dev.qixils.crowdcontrol.socket: An incoming packet from the Crowd Control TCP server which represents an effect to be played.
Request.Target - Class in dev.qixils.crowdcontrol.socket: A recipient of an effect.
Request.Type - Enum in dev.qixils.crowdcontrol.socket: The type of incoming packet.
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(Request, Response.ResultType, String, long) - Constructor for class dev.qixils.crowdcontrol.socket.Response: Constructs a response to a Request given its ID, the result of executing the effect, and an associated message.
Response.Builder - Class in dev.qixils.crowdcontrol.socket: Mutable builder for the immutable Response class.
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.
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

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.
server() - Static method in class dev.qixils.crowdcontrol.CrowdControl: Returns a builder for a new CrowdControl instance operating in server mode.
ServerSocketManager - Class in dev.qixils.crowdcontrol.socket: Manages the connection to Crowd Control clients.
ServerSocketManager(CrowdControl) - Constructor for class dev.qixils.crowdcontrol.socket.ServerSocketManager: Creates a new server-side socket manager.
shutdown() - Method in class dev.qixils.crowdcontrol.CrowdControl: Deprecated.
providing error messages via CrowdControl.shutdown(String) is recommended
shutdown() - Method in interface dev.qixils.crowdcontrol.socket.SocketManager: Deprecated.
providing error messages via SocketManager.shutdown(String) is recommended
shutdown(Request, String) - Method in class dev.qixils.crowdcontrol.CrowdControl: Shuts down the internal connection to the Crowd Control server and sends a corresponding error message to the streamer(s).
shutdown(Request, String) - Method in class dev.qixils.crowdcontrol.socket.ClientSocketManager
shutdown(Request, String) - Method in class dev.qixils.crowdcontrol.socket.ServerSocketManager
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 class dev.qixils.crowdcontrol.CrowdControl: Shuts down the internal connection to the Crowd Control server and sends a corresponding error message to the streamer(s).
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.
START - dev.qixils.crowdcontrol.socket.Request.Type: Indicates that you should start an effect, if available.
STOP - dev.qixils.crowdcontrol.socket.Request.Type: Indicates that you should stop an effect.
Subscribe - Annotation Type in dev.qixils.crowdcontrol: Indicates that the annotated method is an effect handler for the provided effect.
SUCCESS - dev.qixils.crowdcontrol.socket.Response.ResultType: The effect was applied successfully.

T

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(Request, long, Consumer<TimedEffect>, Consumer<TimedEffect>) - Constructor for class dev.qixils.crowdcontrol.TimedEffect: Creates a new TimedEffect.
TimedEffect(Request, String, long, Consumer<TimedEffect>, Consumer<TimedEffect>) - Constructor for class dev.qixils.crowdcontrol.TimedEffect: Creates a new TimedEffect.
TimedEffect(Request, String, Duration, Consumer<TimedEffect>, Consumer<TimedEffect>) - Constructor for class dev.qixils.crowdcontrol.TimedEffect: Creates a new TimedEffect.
TimedEffect(Request, Duration, Consumer<TimedEffect>, Consumer<TimedEffect>) - Constructor for class dev.qixils.crowdcontrol.TimedEffect: Creates a new TimedEffect.
timeRemaining(long) - Method in class dev.qixils.crowdcontrol.socket.Response.Builder: Sets the time left on the referenced effect in milliseconds.
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.Response: Gets a mutable Response.Builder representing this Response.
toJSON() - Method in interface dev.qixils.crowdcontrol.socket.JsonObject: Converts this object to its JSON representation.
toJSON() - Method in class dev.qixils.crowdcontrol.socket.Response: Outputs this object as a JSON string for use in the server connection.
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 effect is unavailable for use.

V

valueOf(String) - Static method in enum dev.qixils.crowdcontrol.CheckResult: 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.ResultType: Returns the enum constant of this type with the specified name.
values() - Static method in enum dev.qixils.crowdcontrol.CheckResult: 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.ResultType: Returns an array containing the constants of this enum type, in the order they are declared.

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