Package com.ultikits.ultitools.websocket

Class CloudPlayerLinks.LinkCompletion

java.lang.Object

com.ultikits.ultitools.websocket.CloudPlayerLinks.LinkCompletion

Enclosing class:

CloudPlayerLinks

public static final class CloudPlayerLinks.LinkCompletion
extends Object

One completed link: how the web user proved the game identity, and what to provision.

Since:

6.3.1

Field Summary

Fields

Modifier and Type	Field	Description
private final String	completionId
private final String	linkId
private final String	playerName
private final UUID	playerUuid
private final CloudPlayerLinks.LinkProof	proof
private final boolean	provisionGameAccount
private final String	webUsername

Constructor Summary

Constructors

Constructor	Description
LinkCompletion(String completionId, String linkId, CloudPlayerLinks.LinkProof proof, UUID playerUuid, String playerName, boolean provisionGameAccount, String webUsername)	Creates a completion; a module test may build one directly.

Method Summary

Modifier and Type	Method	Description
String	completionId()
String	linkId()
String	playerName()
UUID	playerUuid()
CloudPlayerLinks.LinkProof	proof()
boolean	provisionGameAccount()
String	toString()
String	webUsername()

Methods inherited from class java.lang.Object

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

Field Details

completionId

private final String completionId

linkId

private final String linkId

proof

private final CloudPlayerLinks.LinkProof proof

playerUuid

private final UUID playerUuid

playerName

private final String playerName

provisionGameAccount

private final boolean provisionGameAccount

webUsername

private final String webUsername

Constructor Details

LinkCompletion

public LinkCompletion(String completionId,
 String linkId,
 CloudPlayerLinks.LinkProof proof,
 UUID playerUuid,
 String playerName,
 boolean provisionGameAccount,
 String webUsername)

Creates a completion; a module test may build one directly.

Parameters:

completionId - the completion message's envelope id

linkId - the id of the link that completed

proof - the proof the web user used

playerUuid - the player's UUID

playerName - the player's name

provisionGameAccount - whether the module must create a game account

webUsername - the UltiKits web username for CloudPlayerLinks.LinkProof.WEB_REGISTRATION, else null

Method Details

completionId

public String completionId()

Returns:

the completion message's envelope id, used for the persisted receipt

linkId

public String linkId()

Returns:

the id of the link that completed

proof

public CloudPlayerLinks.LinkProof proof()

Returns:

the proof the web user used

playerUuid

public UUID playerUuid()

Returns:

the player's UUID

playerName

public String playerName()

Returns:

the player's name

provisionGameAccount

public boolean provisionGameAccount()

Returns:

whether the module must create a game account for this player

webUsername

public String webUsername()

Returns:

the UltiKits web username for CloudPlayerLinks.LinkProof.WEB_REGISTRATION, otherwise null

toString

public String toString()

Overrides:

toString in class Object