Package live.crowdcontrol.cc4j.websocket.payload

Class CCUserRecord

java.lang.Object

live.crowdcontrol.cc4j.websocket.payload.CCUserRecord

All Implemented Interfaces:

IUserRecord

public class CCUserRecord
extends Object
implements IUserRecord

A record detailing information about a Crowd Control user.

Constructor Summary

Constructors

Constructor	Description
CCUserRecord(@NotNull String ccUID, @NotNull String name, @NotNull ProfileType profile, @NotNull String originID, @NotNull String image)	Creates a user record.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getId()	Gets the user's Crowd Control User ID.
@NotNull String	getImage()	Gets the user's profile picture URL.
@NotNull String	getName()	Gets the user's display name.
@NotNull String	getOriginId()	Gets the ID of the user on their home platform.
@NotNull ProfileType	getProfile()	Gets the type of profile the user logged in with.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CCUserRecord

public CCUserRecord(@Pattern("^ccuid-[0-7][0-9a-hjkmnp-tv-z]{25}$") @NotNull
 @NotNull String ccUID,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull ProfileType profile,
 @NotNull
 @NotNull String originID,
 @NotNull
 @NotNull String image)

Creates a user record.

Parameters:

ccUID - user ID

name - display name

profile - profile type

originID - profile ID

image - profile picture URL

Method Details

getId

@Pattern("^ccuid-[0-7][0-9a-hjkmnp-tv-z]{25}$")
@NotNull
public @NotNull String getId()

Description copied from interface: IUserRecord

Gets the user's Crowd Control User ID.

Specified by:

getId in interface IUserRecord

Returns:

ccUID

getName

@NotNull
public @NotNull String getName()

Description copied from interface: IUserRecord

Gets the user's display name.

Specified by:

getName in interface IUserRecord

Returns:

display name

getProfile

@NotNull
public @NotNull ProfileType getProfile()

Description copied from interface: IUserRecord

Gets the type of profile the user logged in with.

Specified by:

getProfile in interface IUserRecord

Returns:

profile type

getOriginId

@NotNull
public @NotNull String getOriginId()

Description copied from interface: IUserRecord

Gets the ID of the user on their home platform.

Specified by:

getOriginId in interface IUserRecord

Returns:

origin id

getImage

@NotNull
public @NotNull String getImage()

Gets the user's profile picture URL.

Returns:

profile picture URL

toString

public String toString()

Overrides:

toString in class Object