Mettre à jour l’activité

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.

PUT /titles/{titleId}/users/{xuid}/activities

Paramètres d’URI

Paramètre	Emplacement	Obligatoire	Type	Description
titleId	path	TRUE	integer	Le titleId du jeu pour lequel la requête est envoyée.
xuid	path	TRUE	string	Le XUID de l’utilisateur auquel la requête actuelle fait référence. Le XUID est représenté sous la forme d’un entier en base 10.

En-tête de requête

Nom	Obligatoire	Type	Description
Authorization	TRUE	integer	L’appelant doit fournir un XToken au format d’autorisation XBL 3.0. Par exemple, Authorization: XBL3.0 x=2553948354698;<encrypted token>)
Content-Type	TRUE	string	ContentType doit être défini sur application/json

Corps de la requête

Nom	Obligatoire	Type	Description
connectionString	TRUE	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.
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.
platform		Platform

Réponses

Nom	Type	Description
204 No Content		L’activité a été définie avec succès.
400 Bad Request	ErrorResponse	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.”
Autres codes d’état	ThrottledEntity	Trop de requêtes. En-têtes Retry-After: integer

ErrorResponse

Nom	Type	Description
debugMessage	string	Version lisible du message d’erreur, utilisable pour le débogage.
errorCode	string	Énumération du code d’erreur.

JoinRestriction

Le paramètre qui détermine qui peut rejoindre le joueur actuel.

Nom	Type	Description
Followed	string
InviteOnly	string
Public	string

Platform

Nom	Type	Description
Android	string
IOS	string
Nintendo	string
PlayStation	string
Scarlett	string
Win32	string
WindowsOneCore	string
XboxOne	string

SetActivityRequest

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.
joinRestriction	JoinRestriction	Le paramètre qui détermine qui peut rejoindre le joueur actuel.
maxPlayers	integer	Le nombre maximal de joueurs pouvant jouer avec ce joueur dans l’activité actuelle.
platform	Platform
sequenceNumber	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.

ThrottledEntity

Nom	Type	Description
currentRequests	string	Nombre actuel de requêtes (simultanéité ou débit).
debugMessage	string	Version lisible du message de limitation, utilisable pour le débogage.
limitType	string	Le type de limite, c’est-à-dire simultanéité ou débit.
maxRequests	string	Nombre maximal de requêtes autorisées (simultanéité ou débit).
periodInSeconds	string	La période en secondes qui s’applique lorsque les limites de débit ou de simultanéité sont dépassées.
version	string	Version actuelle du contrat de limitation.

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

Mettre à jour l'activité

Mettre à jour l’activité

Paramètres d’URI

En-tête de requête

Corps de la requête

Réponses

Définitions

ErrorResponse

JoinRestriction

Platform

SetActivityRequest

ThrottledEntity

​Mettre à jour l’activité

​Paramètres d’URI

​En-tête de requête

​Corps de la requête

​Réponses

​Définitions

​ErrorResponse

​JoinRestriction

​Platform

​SetActivityRequest

​ThrottledEntity

Mettre à jour l’activité

Paramètres d’URI

En-tête de requête

Corps de la requête

Réponses

Définitions

ErrorResponse

JoinRestriction

Platform

SetActivityRequest

ThrottledEntity