Définit ou met à jour l’activité d’un utilisateur qui joue à un titre précis.
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 donné. 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 au moyen de RTA.
La chaîne de connexion est l’objet transmis au client qui se connecte afin de se joindre à la partie. La chaîne de connexion contient habituellement des renseignements comme l’adresse IP du serveur pour permettre à l’utilisateur qui se joint 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 se joindre au joueur actuel.
sequenceNumber
TRUE
string
Il s’agit de la représentation sous forme de chaîne d’un nombre à croissance monotone (ulong) que le client doit transmettre pour 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, puisqu’elle est garantie d’être 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 servant à regrouper tous les utilisateurs qui jouent dans la même partie.
maxPlayers
integer
Le nombre maximal de joueurs qui peuvent 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, il ne sera possible de s’y joindre que sur cette plateforme. Si la plateforme n’est pas définie, il sera possible de se joindre à l’activité sur toutes les plateformes sur lesquelles le jeu peut être joué.
Nom
Type
Description
connectionString
string
La chaîne de connexion est l’objet transmis au client qui se connecte afin de se joindre à la partie. La chaîne de connexion contient habituellement des renseignements comme l’adresse IP du serveur pour permettre à l’utilisateur qui se joint 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 servant à regrouper tous les utilisateurs qui jouent dans la même partie.
Il s’agit de la représentation sous forme de chaîne d’un nombre à croissance monotone (ulong) que le client doit transmettre pour 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, puisqu’elle est garantie d’être croissante. Doit être supérieur à 0 et ne peut pas dépasser la valeur maximale d’un ulong.
