Interface: JoinTokenClaims
Defined in: server/tokens.ts:15
What a join token says. See createJoinToken.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
player | string | The player this token speaks for. | server/tokens.ts:17 |
name? | string | The player's account name. Rooms see it as player.name. Leave it out for guests: Accounts takes a token with a name for a signed-in player. | server/tokens.ts:22 |
scope? | string | If set, the token only opens the room or matchmaking queue with this id. | server/tokens.ts:24 |
party? | Party | The party the player queues with: friends who are to be matched together. Every member's token carries the same id, and size says how many they are. Only your server should make these, once it knows the player is in that party: a player who could name any party could join a stranger's. | server/tokens.ts:32 |
expiresIn? | number | Lifetime in seconds. Defaults to one hour. | server/tokens.ts:34 |