Obter atividade
Obtém a atividade de um usuário que está jogando um título específico. Essa API permite que um cliente ou servidor de jogo obtenha a atividade de um usuário que está jogando um determinado título.GET /titles/{titleId}/users/{xuid}/activities
Parâmetros de URI
| Parâmetro | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| titleId | path | TRUE | integer | O titleId do jogo para o qual a solicitação está sendo enviada. |
| xuid | path | TRUE | string | O XUID do usuário referenciado na solicitação atual. O XUID é representado como um inteiro de base 10. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Authorization | TRUE | integer | O chamador deve fornecer um XToken no formato de autorização XBL 3.0. Por exemplo, Authorization: XBL3.0 x=2553948354698;>encrypted token<) |
| Content-Type | TRUE | string | ContentType deve ser definido como application/json |
Respostas
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK | GetActivityResponse | Um objeto retornado com a atividade do usuário fornecido. |
| 204 No Content | A solicitação foi bem-sucedida, mas nenhuma atividade foi encontrada para retornar. | |
| 400 Bad Request | ErrorResponse | Ocorreu um erro ao processar a solicitação. Códigos de erro possíveis: “RequestValidationError: The request validation has failed.”, ” AuthorizationError: The caller is not allowed to access the resource. Too many requests.” |
| Outros códigos de status | ThrottledEntity | Excesso de solicitações. Cabeçalhos Retry-After: integer |
Definições
ErrorResponse
| Nome | Tipo | Descrição |
|---|---|---|
| debugMessage | string | Versão legível da mensagem de erro que pode ser usada para depuração. |
| errorCode | string | Enumeração do código de erro. |
GetActivityResponse
| Nome | Tipo | Descrição |
|---|---|---|
| connectionString | string | A cadeia de conexão é o objeto passado ao cliente que está se conectando para que ele ingresse no jogo. A cadeia de conexão geralmente contém informações como o IP do servidor para permitir que o usuário que está ingressando se conecte. O comprimento da cadeia de conexão é limitado a 512 caracteres. |
| currentPlayers | integer | O número de jogadores que já estão jogando com o usuário em uma atividade multijogador. |
| groupId | string | Um identificador exclusivo para agrupar todos os usuários que estão jogando como parte do mesmo jogo. |
| joinRestriction | JoinRestriction | A configuração que define quem pode ingressar com o jogador atual. |
| maxPlayers | integer | O número máximo de jogadores que podem jogar com esse jogador na atividade atual. |
| platform | Platform | |
| sequenceNumber | string | Esta é uma representação em cadeia de caracteres de um número monotonicamente crescente (ulong) que o cliente deve passar em cada solicitação. Ele é usado para garantir a ordem das atualizações de uma atividade. Um bom exemplo de sequenceNumber é o horário unix do cliente, pois ele é garantidamente crescente. Deve ser maior que 0 e não pode ser maior que o ulong máximo. |
| titleId | integer | O titleId do jogo para o qual a atividade foi solicitada. |
JoinRestriction
| Nome | Tipo | Descrição |
|---|---|---|
| Followed | string | |
| InviteOnly | string | |
| Public | string |
Platform
| Nome | Tipo | Descrição |
|---|---|---|
| Android | string | |
| IOS | string | |
| Nintendo | string | |
| PlayStation | string |
ThrottledEntity
| Nome | Tipo | Descrição |
|---|---|---|
| currentRequests | string | Número atual de solicitações: simultaneidade ou taxa. |
| debugMessage | string | Versão legível da mensagem de limitação que pode ser usada para depuração. |
| limitType | string | O tipo de limite, ou seja, simultaneidade ou taxa. |
| maxRequests | string | Máximo de solicitações permitidas: simultaneidade ou taxa. |
| periodInSeconds | string | O período, em segundos, que se aplica quando os limites de taxa ou simultaneidade são excedidos. |
| version | string | Versão atual do contrato de limitação. |