Package live.crowdcontrol.cc4j.websocket.data

Class LoginData

java.lang.Object

live.crowdcontrol.cc4j.websocket.data.LoginData

public class LoginData
extends Object

Defines an attempt to subscribe to channels of information on the WebSocket.

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull String	CODE_PATTERN

Constructor Summary

Constructors

Constructor	Description
LoginData(@NotNull String appID, @NotNull String code)	Creates a login body.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getAppID()	Gets the ID of the application.
@NotNull String	getCode()	Gets the code to log in with, typically conforming to CODE_PATTERN.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CODE_PATTERN

@RegExp
@NotNull
public static final @NotNull String CODE_PATTERN

See Also:

• Constant Field Values

Constructor Details

LoginData

public LoginData(@NotNull
 @NotNull String appID,
 @Pattern("^[BCDFGHJKLMNPQRTW6789]{6}$") @NotNull
 @NotNull String code)

Creates a login body.

Parameters:

appID - the ID of the application

code - the code to log in with, typically conforming to CODE_PATTERN

Method Details

getAppID

@NotNull
public @NotNull String getAppID()

Gets the ID of the application.

Returns:

application ID

getCode

@Pattern("^[BCDFGHJKLMNPQRTW6789]{6}$")
@NotNull
public @NotNull String getCode()

Gets the code to log in with, typically conforming to CODE_PATTERN.

Returns:

login code