POST (/handles)
ユーザーの現在のアクティビティのマルチプレイヤー セッションを設定し、必要な場合はセッション メンバーを招待します。
重要:
このメソッドは、2015 Multiplayer によって使用され、そのバージョン以降のマルチプレイヤーにのみ適用されます。 これは 104/105 以降のテンプレート コントラクトで使用するためのもので、すべての要求でヘッダー要素 X-Xbl-Contract-Version: に 104/105 以降を指定する必要があります。
解説
この HTTP/REST メソッドは、現在のアクティビティのセッションを設定するために使用できます。 この場合、Microsoft.Xbox.Services.Multiplayer.MultiplayerService.SetActivityAsync でメソッドをラップできます。 要求本文では、JSON ファイル内の sessionRef オブジェクトを使用し、type フィールドを "activity" に設定してセッションへの参照を定義する必要があります。 応答本文は取得されません。 セッションへの参照で指定する項目の定義については、「Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference」を参照してください。
この POST メソッドは、ハンドルによって指定されたユーザーをセッションに招待するためにも使用できます。 この場合、Microsoft.Xbox.Services.Multiplayer.MultiplayerService.SendInvitesAsync でメソッドをラップできます。 POST メソッドをこのように使用する場合、要求本文でセッションへの参照を定義する必要がありますが、type フィールドは "invite" に設定します。 応答本文は招待ハンドルです。
URI パラメーター
なし
HTTP ステータス コード
サービスは、MPSD に適用される HTTP ステータス コードを返します。
リクエストの本文
アクティビティを設定するための要求本文。
{
"version": 1,
"type": "activity",
"sessionRef": {
"scid": "bd6c41c3-01c3-468a-a3b5-3e0fe8133862",
"templateName": "deathmatch",
// The session name is optional in a POST; if not specified, MPSD fills in a GUID.//
"name": "session-49"
},
}
招待を送信するための要求本文
{
// Common handle fields
"id: "47ca0049-a5ba-4bc1-aa22-fcf834ce4c13",
"version": 1,
"type": "invite",
"sessionRef": {
"scid": "bd6c41c3-01c3-468a-a3b5-3e0fe8133862",
"templateName": "deathmatch",
"name": "session-49"
},
"inviteAttributes": {
"titleId" : {titleId}, // The title being invited to, in decimal uint32. This value is used to find the title name and/or image.
"context" : {context}, // The title defined context token. Must be 256 characters or less when URI-encoded.
"contextString" : {contextstring}, // The string name of a custom invite string to display in the invite notification.
"senderString" : {sender} // The string name of the sender when the sender is a service.
},
"invitedXuid": "3210",
}