Uses of Class dev.qixils.crowdcontrol.socket.Request (java-crowd-control 3.2.1 API)

Packages that use Request
Package	Description
dev.qixils.crowdcontrol	Provides most of the basic classes required to implement `CrowdControl` into your project.
dev.qixils.crowdcontrol.socket	Provides classes related to network communication, such as `Request` and `Response`.

Uses of Request in dev.qixils.crowdcontrol

Methods in dev.qixils.crowdcontrol that return Request
Modifier and Type	Method	Description
`@NotNull Request`	TimedEffect.`getRequest()`	Gets the request that this timed effect corresponds to.

Methods in dev.qixils.crowdcontrol with parameters of type Request
Modifier and Type	Method	Description
`void`	CrowdControl.`handle(@NotNull Request request)`	Handles an incoming `Request` by executing the relevant handler.
`static boolean`	TimedEffect.`isActive(@NotNull String effectGroup, @NotNull Request request)`	Determines if an effect with the provided name is currently active for any streamer targeted by the provided request.
`void`	CrowdControl.`shutdown(@Nullable Request cause, @Nullable String reason)`	Shuts down the internal connection to the Crowd Control server and sends a corresponding error message to the streamer(s).

Method parameters in dev.qixils.crowdcontrol with type arguments of type Request
Modifier and Type	Method	Description
`void`	CrowdControl.`registerCheck(@NotNull Function<Request,CheckResult> check)`	Registers a check which will be called for every incoming `Request`.
`void`	CrowdControl.`registerHandler(@NotNull String effect, @NotNull Consumer<Request> handler)`	Registers an effect handler which does not immediately return a `Response`.
`void`	CrowdControl.`registerHandler(@NotNull String effect, @NotNull Function<Request,Response> handler)`	Registers a function to handle an effect.

Constructors in dev.qixils.crowdcontrol with parameters of type Request
Constructor	Description
`TimedEffect(@NotNull Request request, long duration, @NotNull Consumer<@NotNull TimedEffect> callback, @Nullable Consumer<@NotNull TimedEffect> completionCallback)`	Creates a new `TimedEffect`.
`TimedEffect(@NotNull Request request, @NotNull String effectGroup, long duration, @NotNull Consumer<@NotNull TimedEffect> callback, @Nullable Consumer<@NotNull TimedEffect> completionCallback)`	Creates a new `TimedEffect`.
`TimedEffect(@NotNull Request request, @NotNull String effectGroup, @NotNull Duration duration, @NotNull Consumer<@NotNull TimedEffect> callback, @Nullable Consumer<@NotNull TimedEffect> completionCallback)`	Creates a new `TimedEffect`.
`TimedEffect(@NotNull Request request, @NotNull Duration duration, @NotNull Consumer<@NotNull TimedEffect> callback, @Nullable Consumer<@NotNull TimedEffect> completionCallback)`	Creates a new `TimedEffect`.

Uses of Request in dev.qixils.crowdcontrol.socket

Methods in dev.qixils.crowdcontrol.socket that return Request
Modifier and Type	Method	Description
`static @NotNull Request`	Request.`fromJSON(@NotNull String json)`	Creates a `Request` object from JSON.
`Request`	Response.`getRequest()`	Gets the unique `Request` that caused this response.

Methods in dev.qixils.crowdcontrol.socket with parameters of type Request
Modifier and Type	Method	Description
`void`	ClientSocketManager.`shutdown(@Nullable Request cause, @Nullable String reason)`
`void`	ServerSocketManager.`shutdown(@Nullable Request cause, @Nullable String reason)`
`void`	SocketManager.`shutdown(@Nullable Request cause, @Nullable String reason)`	Shuts down the Crowd Control socket and sends an explanation message to the streamer.

Constructors in dev.qixils.crowdcontrol.socket with parameters of type Request
Constructor	Description
`Builder(@NotNull Request request)`	Creates a new builder representing the `Response` to a `Request`.
`Response(@NotNull Request request, Response.ResultType type, @NotNull String message, long timeRemaining)`	Constructs a response to a `Request` given its ID, the result of executing the effect, and an associated message.