GameSession (JSON)
代表多人遊戲工作階段之遊戲資料的 JSON 物件。 GameSession JSON 物件具有下列規格。| 成員 | 類型 | 描述 |
|---|---|---|
| creationTime | DateTime | 工作階段建立的日期和時間，以 UTC 表示。 |
| customData | 8 位元不帶正負號的整數陣列 | 1024 位元組的遊戲特定工作階段資料。此值對伺服器而言是不透明的。 |
| displayName | string | 遊戲工作階段的顯示名稱，長度上限為 128 個字元。此值對伺服器而言是不透明的。 |
| hasEnded | 布林值 | 如果工作階段已結束則為 True，否則為 false。將此欄位設定為 true 會將遊戲工作階段標示為唯讀，以防止再有資料提交至該工作階段。 |
| isClosed | 布林值 | 如果工作階段已關閉且無法再新增玩家則為 True，否則為 false。如果此值為 true，加入工作階段的要求會遭到拒絕。 |
| maxPlayers | 32 位元帶正負號的整數 | 可同時在工作階段中的玩家數目上限。值的範圍為 2-16。一旦工作階段包含玩家數目上限，後續加入工作階段的要求就會遭到拒絕。 |
| playersCanBeRemovedBy | PlayerAcl | 指出允許從工作階段中移除其他玩家之玩家的值。可能的值為 NoOne、Self 和 AnyPlayer。 |
| roster | player 物件陣列 | 工作階段中玩家的陣列。名單包含目前的玩家，以及先前曾在工作階段中但已離開的玩家。名單中玩家的順序永遠不會變更。新玩家會新增至陣列的結尾。 |
| seatsAvailable | 32 位元帶正負號的整數 | 在達到玩家數目上限之前，仍可加入工作階段的玩家數目。此值為唯讀，且一律小於 maxPlayers 欄位的值。 |
| sessionId | string | MPSD 在建立工作階段時指派的工作階段識別碼。存取工作階段中儲存的資訊時，此值通常會包含在 URI 中。 |
| titleId | 32 位元不帶正負號的整數 | 建立遊戲工作階段之遊戲的識別碼。 |
| variant | 32 位元帶正負號的整數 | 遊戲變體。此值對伺服器而言是不透明的。 |
| visibility | VisibilityLevel | 指出工作階段可見度的值。可能的值為：PlayersCurrentlyInSession、PlayersEverInSession 和 Everyone。 |
範例 JSON 語法
{
"sessionId": "702e5aaf-e7bd-4a7c-abea-9dd4be10edec",
"titleId": 1297287259,
"variant": 1,
"displayName": "Contoso Cards",
"creationTime": "2011-06-23T17:13:06Z",
"customData": null,
"maxPlayers": 4,
"seatsAvailable": 4,
"isClosed": false,
"hasEnded": false,
"roster": [],
"visibility": "PlayersCurrentlyInSession",
"playersCanBeRemovedBy": "Self",
}