Définit ou met à jour l’activité d’un utilisateur qui joue à un titre spécifique.
Cette API permet à un client ou à un serveur de jeu de définir ou de mettre à jour l’activité multijoueur d’un utilisateur qui joue à un titre particulier. L’activité doit être définie dès que l’utilisateur est actif dans une activité multijoueur. Les utilisateurs XBOX Live pourront s’abonner aux changements d’activité d’autres utilisateurs (généralement des amis) et ces mises à jour seront envoyées aux clients XBOX via RTA.
La chaîne de connexion est l’objet transmis au client qui se connecte afin de rejoindre la partie. La chaîne de connexion contient généralement des informations telles que l’adresse IP du serveur pour permettre à l’utilisateur qui rejoint la partie de se connecter. La longueur de la chaîne de connexion est limitée à 512 caractères.
joinRestriction
TRUE
JoinRestriction
Le paramètre qui détermine qui peut rejoindre le joueur actuel.
sequenceNumber
TRUE
string
Il s’agit de la représentation sous forme de chaîne d’un nombre monotone croissant (ulong) que le client doit transmettre à chaque requête. Il sert à garantir l’ordre des mises à jour d’une activité. Un bon exemple de sequenceNumber est l’heure Unix du client, car elle est garantie croissante. Doit être supérieur à 0 et ne peut pas dépasser la valeur maximale d’un ulong.
currentPlayers
integer
Le nombre de joueurs qui jouent déjà avec l’utilisateur dans une activité multijoueur.
groupId
string
Un identificateur unique permettant de regrouper tous les utilisateurs qui jouent à la même partie.
maxPlayers
integer
Le nombre maximal de joueurs pouvant jouer avec ce joueur dans l’activité actuelle.
Une erreur s’est produite lors du traitement de la requête. Codes d’erreur possibles : “RequestValidationError: The request validation has failed.”, ” AuthorizationError: The caller is not allowed to access the resource. Too many requests.”
Si la plateforme de l’activité est définie dans la requête, l’activité ne pourra être rejointe que sur cette plateforme. Si la plateforme n’est pas définie, l’activité pourra être rejointe sur toutes les plateformes sur lesquelles le jeu est disponible.
Nom
Type
Description
connectionString
string
La chaîne de connexion est l’objet transmis au client qui se connecte afin de rejoindre la partie. La chaîne de connexion contient généralement des informations telles que l’adresse IP du serveur pour permettre à l’utilisateur qui rejoint la partie de se connecter. La longueur de la chaîne de connexion est limitée à 512 caractères.
currentPlayers
integer
Le nombre de joueurs qui jouent déjà avec l’utilisateur dans une activité multijoueur.
groupId
string
Un identificateur unique permettant de regrouper tous les utilisateurs qui jouent à la même partie.
Il s’agit de la représentation sous forme de chaîne d’un nombre monotone croissant (ulong) que le client doit transmettre à chaque requête. Il sert à garantir l’ordre des mises à jour d’une activité. Un bon exemple de sequenceNumber est l’heure Unix du client, car elle est garantie croissante. Doit être supérieur à 0 et ne peut pas dépasser la valeur maximale d’un ulong.
