ai.tock.bot.engine.user

Class PlayerId

ai.tock.bot.engine.user.PlayerId

public class PlayerId

The user identifier.

Contains a (unique) id, a enum PlayerType and an optional clientId.

The clientId field is used in a "not mandatory logging" scenario, and to manage multi-platform dialogs.

A class PlayerId is equals to another class PlayerId if both id are equals.

See Also:

enum PlayerType, class PlayerId, class PlayerId

Constructor Detail

PlayerId

public PlayerId(@NotNull
                java.lang.String id,
                @NotNull
                PlayerType type,
                @Nullable
                java.lang.String clientId)

The user identifier.

Contains a (unique) id, a enum PlayerType and an optional clientId.

The clientId field is used in a "not mandatory logging" scenario, and to manage multi-platform dialogs.

A class PlayerId is equals to another class PlayerId if both id are equals.

Parameters:

id - The unique identifier of the player.

type - The type of the player.

clientId - The optional business client id.

See Also:

enum PlayerType, class PlayerId, class PlayerId

Method Detail

equals

public boolean equals(@Nullable
                      java.lang.Object other)

hashCode

public int hashCode()

getId

@NotNull
public java.lang.String getId()

The unique identifier of the player.

getType

@NotNull
public PlayerType getType()

The type of the player.

getClientId

@Nullable
public java.lang.String getClientId()

The optional business client id.

component1

@NotNull
public java.lang.String component1()

The unique identifier of the player.

component2

@NotNull
public PlayerType component2()

The type of the player.

component3

@Nullable
public java.lang.String component3()

The optional business client id.

copy

@NotNull
public PlayerId copy(@NotNull
                              java.lang.String id,
                              @NotNull
                              PlayerType type,
                              @Nullable
                              java.lang.String clientId)

The user identifier.

Contains a (unique) id, a enum PlayerType and an optional clientId.

The clientId field is used in a "not mandatory logging" scenario, and to manage multi-platform dialogs.

A class PlayerId is equals to another class PlayerId if both id are equals.

See Also:

enum PlayerType, class PlayerId, class PlayerId

toString

@NotNull
public java.lang.String toString()

The user identifier.

Contains a (unique) id, a enum PlayerType and an optional clientId.

The clientId field is used in a "not mandatory logging" scenario, and to manage multi-platform dialogs.

A class PlayerId is equals to another class PlayerId if both id are equals.

See Also:

enum PlayerType, class PlayerId, class PlayerId