更新活动
设置或更新玩特定游戏的用户的活动。
此 API 允许游戏客户端或服务器为玩特定游戏的用户设置/更新多人游戏活动。 用户在多人游戏活动中处于活动状态后,必须立即设置活动。 Xbox Live用户将能够订阅其他用户(通常是好友)的活动更改,并且这些更新将通过 RTA 推送到 Xbox 客户端。
PUT /titles/{titleId}/users/{xuid}/activities
URI 参数
参数 |
In |
必需 |
类型 |
说明 |
titleId |
路径 |
TRUE |
integer |
要为其发送请求的游戏的 titleId。 |
xuid |
路径 |
TRUE |
字符串 |
当前请求中引用的用户的 XUID。 XUID 表示为基 10 整数。 |
名称 |
必需 |
类型 |
说明 |
授权 |
TRUE |
integer |
调用方必须提供采用 XBL 3.0 授权格式的 XToken。 例如,授权: XBL3.0 x=2553948354698;<加密令牌>) |
Content-Type |
TRUE |
字符串 |
ContentType 必须设置为 application/json |
请求正文
名称 |
必需 |
类型 |
说明 |
connectionString |
TRUE |
字符串 |
连接字符串是传递给连接客户端以加入游戏的对象。 连接字符串通常包含服务器 IP 等信息,以使联接用户能够进行连接。 连接字符串的长度限制为 512 个字符。 |
joinRestriction |
TRUE |
JoinRestriction |
允许谁可以加入当前玩家的设置。 |
sequenceNumber |
TRUE |
字符串 |
这是客户端必须为每个请求传入的单调递增数字 (ulong) 的字符串表示形式。 它用于保证活动更新的顺序。 sequenceNumber 的一个很好的示例可能是客户端的 unix 时间,因为它保证会增加。 必须大于 0,并且不能大于最大 ulong。 |
currentPlayers |
|
integer |
在多人游戏活动中已与用户玩的玩家数量。 |
groupId |
|
字符串 |
一个唯一标识符,用于对作为同一游戏一部分玩的所有用户进行分组。 |
maxPlayers |
|
integer |
可在当前活动中与此玩家一起玩游戏的最大玩家数。 |
platform |
|
平台 |
|
响应
名称 |
类型 |
说明 |
204 无内容 |
|
已成功设置活动。 |
400 错误请求 |
ErrorResponse |
处理请求时出错... 可能的错误代码:"RequestValidationError: 请求验证失败。",AuthorizationError: 不允许调用方访问资源。 请求过多。" |
其他状态代码 |
ThrottledEntity |
请求过多。 标头重试-之后:整数 |
定义
ErrorResponse
名称 |
类型 |
说明 |
debugMessage |
字符串 |
可用于调试的错误消息的人工可读版本。 |
errorCode |
字符串 |
错误代码枚举。 |
JoinRestriction
允许谁可以加入当前玩家的设置。
名称 |
类型 |
说明 |
已关注 |
字符串 |
|
InviteOnly |
字符串 |
|
开放 |
字符串 |
|
名称 |
类型 |
说明 |
Android |
字符串 |
|
IOS |
字符串 |
|
Nintendo |
字符串 |
|
PlayStation |
字符串 |
|
Scarlett |
字符串 |
|
Win32 |
字符串 |
|
WindowsOneCore |
字符串 |
|
XboxOne |
字符串 |
|
SetActivityRequest
如果活动平台是在请求中设置的,则它只能在该平台上加入。 如果未设置平台,则该活动可在游戏可在所有平台上加入。
名称 |
类型 |
说明 |
connectionString |
字符串 |
连接字符串是传递给连接客户端以加入游戏的对象。 连接字符串通常包含服务器 IP 等信息,以使联接用户能够进行连接。 连接字符串的长度限制为 512 个字符。 |
currentPlayers |
integer |
在多人游戏活动中已与用户玩的玩家数量。 |
groupId |
字符串 |
一个唯一标识符,用于对作为同一游戏一部分玩的所有用户进行分组。 |
joinRestriction |
JoinRestriction |
允许谁可以加入当前玩家的设置。 |
maxPlayers |
integer |
可在当前活动中与此玩家一起玩游戏的最大玩家数。 |
platform |
平台 |
|
sequenceNumber |
字符串 |
这是客户端必须为每个请求传入的单调递增数字 (ulong) 的字符串表示形式。 它用于保证活动更新的顺序。 sequenceNumber 的一个很好的示例可能是客户端的 unix 时间,因为它保证会增加。 必须大于 0,并且不能大于最大 ulong。 |
ThrottledEntity
名称 |
类型 |
说明 |
currentRequests |
字符串 |
当前请求数 - 并发或速率。 |
debugMessage |
字符串 |
可用于调试的限制消息的人工可读版本。 |
LimitType |
字符串 |
限制类型,即并发或速率。 |
maxRequests |
字符串 |
允许的最大请求数 - 并发或速率。 |
periodInSeconds |
字符串 |
超出速率或并发限制时适用的时段(以秒为单位)。 |
版本 |
字符串 |
当前限制协定版本。 |