MultiplayerSessionRequest (JSON)
MultiplayerSession オブジェクトの操作のために渡される要求 JSON オブジェクト。
MultiplayerSessionRequest JSON オブジェクトの仕様は次のとおりです。
メンバー | 種類 | 説明 |
---|---|---|
constants | オブジェクト | セッションの定数を作成するためにセッション テンプレートとマージされる読み取り専用設定。 |
properties | オブジェクト | セッションのプロパティにマージされる変更。 |
members.me | オブジェクト | 最上位の定数およびプロパティとほとんど同じ働きをする定数およびプロパティ。 PUT メソッドでは、ユーザーがセッションのメンバーである必要があり、必要に応じてユーザーを追加します。 "me" が null として指定されている場合、その要求を行うメンバーはセッションから削除されます。 |
members | オブジェクト | セッションに追加するユーザー (0 から始まるインデックスをキーとする) を表すその他のオブジェクト。 セッションに既にメンバーが含まれている場合でも、要求内のメンバーの番号は常に 0 から始まります。 メンバーは、要求に記載されている順序でセッションに追加されます。 メンバー プロパティは、それらが属するユーザーによってのみ設定可能です。 |
servers | オブジェクト | セッションに関連付けられている一連の参加サーバーの更新および追加を示す値。 サーバーが null として指定された場合、そのサーバー エントリはセッションから削除されます。 |
要求の構造
{
"constants": { /* Property Bag */ },
"properties": { /* Property Bag */ },
"members": {
// Requires a service principal. Existing members can be deleted by index.
// Not available on large sessions.
"5": null,
// Reservation requests must start with zero. New users will get added in order to the end of the session's member list.
// Large sessions don't support reservations.
"reserve_0": {
"constants": { /* Property Bag */ }
},
"reserve_1": {
"constants": { /* Property Bag */ }
},
// Requires a user principal with a xuid claim. Can be 'null' to remove myself from the session.
"me": {
"constants": { /* Property Bag */ },
"properties": { /* Property Bag */ },
}
},
// Requires a server principal.
"servers": {
// Can be any name. The value can be 'null' to remove the server from the session.
"name": {
"constants": { /* Property Bag */ },
"properties": { /* Property Bag */ }
}
}
}
関連項目
親
JavaScript Object Notation (JSON) オブジェクト リファレンス
リファレンス
PUT (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName})