Mise à jour de la présence d'un utilisateur au moyen de REST

Cette rubrique fournit un exemple de code pour mettre à jour les chaînes de présence enrichie. Pour mettre à jour une chaîne de présence enrichie dans votre titre, appelez l’URI Write Title avec les paramètres appropriés dans un objet JSON. Cet appel RESTful est également encapsulé par les API des services XBOX (XSAPI). Pour plus d’informations sur l’API associée à cet appel, consultez XblPresenceSetPresenceAsync. L’URI se présente comme suit :

POST /users/xuid({xuid})/devices/current/titles/current

Les champs suivants servent uniquement à définir les chaînes de présence enrichie. D’autres champs facultatifs sont liés à l’écriture de la présence pour un titre, mais ils ne sont pas répertoriés dans cette rubrique.

Objet TitleRequest

Propriété	Type	Obligatoire	Description
Activity	ActivityRequest	Non	L’enregistrement qui décrit les informations dans le titre (présence enrichie et informations multimédias, le cas échéant)

Objet ActivityRequest

Propriété	Type	Obligatoire	Description
richPresence	RichPresenceRequest	Non	Le friendlyName de la chaîne de présence enrichie à utiliser

Objet RichPresenceRequest

Propriété	Type	Obligatoire	Description
Id	String	Oui	Le friendlyName de la chaîne de présence enrichie à utiliser
Scid	String	Oui	Le SCID qui indique où les chaînes de présence enrichie sont définies

Par exemple, pour mettre à jour la présence enrichie de l’utilisateur dont le XUID est 12345, l’appel se présente comme suit :

POST /users/xuid(12345)/devices/current/titles/current

Il comporte le corps JSON suivant.

          {
            activity:
            {
              richPresence:
              {
                id:"playingMap",
                scid:"0000-0000-0000-0000-01010101"
              }
            }
          }

Avec l’API wrapper, il s’agit d’un appel à XblPresenceSetPresenceAsync. Si vous maintenez les données de joueur XBOX à jour, vous n’avez pas besoin de redéfinir la chaîne de présence enrichie pour compléter le champ chaque fois que les données changent. Dans l’exemple précédent, la carte actuelle est utilisée. Le service Presence recherche les données dans les données de joueur XBOX lorsqu’un utilisateur tente de lire la chaîne, afin de renseigner la valeur actuelle. Même si l’utilisateur passe d’une carte à une autre, vous n’avez pas à redéfinir la chaîne de présence enrichie dans votre jeu, tant que vous envoyez les événements appropriés aux données de joueur XBOX. La propagation des données dans le système de données de joueur XBOX peut prendre quelques secondes. Lorsqu’une personne tente de lire la présence enrichie de l’utilisateur 12345, le service examine les paramètres régionaux demandés et met en forme la chaîne en conséquence avant de la retourner. Dans ce cas, supposons qu’un utilisateur souhaite lire la chaîne en-US. La lecture de la présence enrichie fonctionne comme suit.

GET /users/xuid(12345)?level=all

Pour plus d’informations sur cet appel, consultez GET (/users/xuid({xuid})). L’API wrapper correspondante est XblPresenceGetPresenceAsync ou XblPresenceGetPresenceForMultipleUsersAsync. Dans l’exemple précédent, vous avez demandé le PresenceRecord de l’utilisateur dont le XUID est 12345. Vous avez également demandé que le niveau de détail soit all. Si vous n’aviez pas spécifié all, la présence enrichie ne serait pas retournée. Avec all, la réponse JSON contient les éléments suivants.

          {
            xuid:"12345",
            state:"online",
            devices:
            [
              {
                type:"D",
                titles:
                [
                  {
                    id:"12345",
                    name:"Buckets are Awesome",
                    lastModified:"2022-08-17T07:15:23.4930000",
                    placement: "full",
                    state:"active",
                    activity:
                    {
                      richPresence:"Playing on map:Mountains"
                    }
                  }
                ]
              }
            ]
          }

XBOX Services

PlayFab

Mise à jour de la présence d'un utilisateur au moyen de REST

Objet TitleRequest

Objet ActivityRequest

Objet RichPresenceRequest

​Objet TitleRequest

​Objet ActivityRequest

​Objet RichPresenceRequest

Objet TitleRequest

Objet ActivityRequest

Objet RichPresenceRequest