MultiplayerActivityDetails (JSON)
A JSON object representing the Microsoft.Xbox.Services.Multiplayer.MultiplayerActivityDetails.
Note:
This object is implemented by the 2015 Multiplayer and applies only to that multiplayer version and later. It is intended for use with template contract 104/105 or later.
The MultiplayerActivityDetails JSON object has the following specification.
| Member | Type | Description |
|---|---|---|
| SessionReference | MultiplayerSessionReference | A Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference object representing identifying information for the session. |
| HandleId | 64-bit unsigned integer | The handle ID corresponding to the activity. |
| TitleId | 32-bit unsigned integer | The title ID that should be launched in order to join the activity. |
| Visibility | MultiplayerSessionVisibility | A Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionVisibility value indicating the visibility state of the session. |
| JoinRestriction | MultiplayerSessionJoinRestriction | A Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionJoinRestriction value indicating the join restriction for the session. This restriction applies if the visiblity field is set to "open". |
| Closed | Boolean value | True if the session is temporarily closed for joining, and false otherwise. |
| OwnerXboxUserId | 64-bit unsigned integer | Xbox user ID of the member who owns the activity. |
| MaxMembersCount | 32-bit unsigned integer | Number of total slots. |
| MembersCount | 32-bit unsigned integer | Number of slots occupied. |
Sample JSON syntax
{
"results": [{
"id": "11111111-ebe0-42da-885f-033860a818f6",
"type": "activity",
"version": 1,
"sessionRef": {
"scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
"templateName": "party",
"name": "e3a836aeac6f4cbe9bcab985494d3175"
},
"titleId": "1234567",
"ownerXuid": "3212",
// Only if ?include=relatedInfo
"relatedInfo": {
"visibility": "open",
"joinRestriction": "followed",
"closed": true,
"maxMembersCount": 8,
"membersCount": 4,
}
},
{
"id": "11111111-ebe0-42da-885f-033860a818f7",
"type": "activity",
"version": 1,
"sessionRef": {
"scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
"templateName": "TitleStorageTestDefault",
"name": "795fcaa7-8377-4281-bd7e-e86c12843632"
},
"titleId": "1234567",
"ownerXuid": "3212",
// Only if ?include=relatedInfo
"relatedInfo": {
"visibility": "open",
"joinRestriction": "followed",
"closed": false,
"maxMembersCount": 8,
"membersCount": 4,
}
}]
}