Package dev.qixils.crowdcontrol.socket

Class Request.Target

java.lang.Object

dev.qixils.crowdcontrol.socket.Request.Target

Enclosing class:

Request

@AvailableSince("3.0.0")
public static final class Request.Target
extends Object

A recipient of an effect.

This corresponds to a Twitch streamer connected to the Crowd Control server.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Request.Target.Builder	Mutable builder for the immutable Request.Target class.

Constructor Summary

Constructors

Constructor	Description
Target(@Nullable String id, @Nullable String name, @Nullable String avatar)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
@Nullable String	getAvatar()	Gets the URL of the recipient's avatar.
@Nullable String	getId()	The recipient's ID.
@Nullable String	getLogin()	The recipient's username.
@Nullable String	getName()	The recipient's display name.
int	hashCode()
@NotNull Request.Target.Builder	toBuilder()	Creates a mutable Request.Target.Builder with a copy of the data in this Request.Target.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Target

@AvailableSince("3.3.0")
@Deprecated
@ScheduledForRemoval(inVersion="3.6.0")
public Target(@Nullable
              @Nullable String id,
              @Nullable
              @Nullable String name,
              @Nullable
              @Nullable String avatar)

Deprecated.

Use the builder instead.

Instantiates a Request.Target with the given streamer information.

Parameters:

id - streamer ID

name - streamer name

avatar - streamer avatar

Since:

3.3.0

Method Detail

getId

@AvailableSince("3.0.0")
@Nullable
@CheckReturnValue
public @Nullable String getId()

The recipient's ID.

Prior to 3.4.0, this method returned an integer representing a Twitch streamer ID. Now, it may return a string representing the ID of a streamer on Twitch or on a different platform. It may also return null if the ID is unknown.

Returns:

streamer ID

Since:

3.0.0

getName

@AvailableSince("3.0.0")
@Nullable
@CheckReturnValue
public @Nullable String getName()

The recipient's display name. May be null if the name is unknown.

Returns:

display name

Since:

3.0.0

getLogin

@AvailableSince("3.5.2")
@Nullable
@CheckReturnValue
public @Nullable String getLogin()

The recipient's username. May be null if the username is unknown.

Returns:

username

Since:

3.5.2

getAvatar

@AvailableSince("3.0.0")
@Nullable
@CheckReturnValue
public @Nullable String getAvatar()

Gets the URL of the recipient's avatar. May be null if the avatar is unknown.

Returns:

avatar URL

Since:

3.0.0

equals

@CheckReturnValue
public boolean equals(@Nullable
                      @Nullable Object o)

Overrides:

equals in class Object

hashCode

@CheckReturnValue
public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

@AvailableSince("3.5.2")
@NotNull
@CheckReturnValue
public @NotNull Request.Target.Builder toBuilder()

Creates a mutable Request.Target.Builder with a copy of the data in this Request.Target.

Returns:

a new Request.Target.Builder

Since:

3.5.2