MultiplayerSessionRequest (JSON)

Objet JSON de requête transmis pour une opération sur un objet MultiplayerSession. L’objet JSON MultiplayerSessionRequest a la spécification suivante.

Membre	Type	Description
constants	object	Paramètres en lecture seule fusionnés avec le modèle de session pour produire les constantes de la session.
properties	object	Modifications à fusionner dans les propriétés de la session.
members.me	object	Constantes et propriétés qui fonctionnent de manière très similaire à leurs équivalents de niveau supérieur. Toute méthode PUT exige que l’utilisateur soit membre de la session et ajoute l’utilisateur si nécessaire. Si “me” est spécifié comme null, le membre qui effectue la requête est retiré de la session.
members	object	Autres objets représentant les utilisateurs à ajouter à la session, indexés par un index de base zéro. Le nombre de membres dans une requête commence toujours à 0, même si la session contient déjà des membres. Les membres sont ajoutés à la session dans l’ordre dans lequel ils apparaissent dans la requête. Les propriétés d’un membre ne peuvent être définies que par l’utilisateur auquel elles appartiennent.
servers	object	Valeurs indiquant les mises à jour et les ajouts à l’ensemble des serveurs participants associés à la session. Si un serveur est spécifié comme null, l’entrée de ce serveur est retirée de la session.

Structure de la requête

{
  "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 */ }
    }
  }
}

Voir aussi

Parent

Référence des objets JSON (JavaScript Object Notation)

Référence

MultiplayerSession (JSON) PUT (/serviceconfigs//sessiontemplates//sessions/)

Dernière modification le 19 octobre 2026

⌘I