删除活动
删除玩特定游戏的用户的活动。
此 API 允许游戏客户端删除玩特定游戏的用户的活动。 游戏应在用户离开多人游戏活动时立即删除该用户的活动。 如果游戏无法删除活动,最终可能会通过状态检查来清理用户的活动。
DELETE /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 |
请求正文
名称 |
必需 |
类型 |
说明 |
sequenceNumber |
TRUE |
字符串 |
这是客户端必须为每个请求传入的单调递增数字 (ulong) 的字符串表示形式。 它用于保证活动更新的顺序。 sequenceNumber 的一个很好的示例可能是客户端的 unix 时间,因为它保证会增加。 必须大于 0,并且不能大于最大 ulong。 |
响应
名称 |
类型 |
说明 |
204 无内容 |
|
已删除该项。 |
400 错误请求 |
ErrorResponse |
处理请求时出错... 可能的错误代码:“RequestValidationError:请求验证失败。”、“AuthorizationError:不允许调用方访问资源。” |
其他状态代码 |
ThrottledEntity |
请求过多。 标头重试-之后:整数 |
定义
DeleteActivityRequest
名称 |
类型 |
说明 |
sequenceNumber |
字符串 |
这是客户端必须为每个请求传入的单调递增数字 (ulong) 的字符串表示形式。 它用于保证活动更新的顺序。 sequenceNumber 的一个很好的示例可能是客户端的 unix 时间,因为它保证会增加。 必须大于 0,并且不能大于最大 ulong。 |
ErrorResponse
名称 |
类型 |
说明 |
debugMessage |
字符串 |
可用于调试的错误消息的人工可读版本。 |
errorCode |
字符串 |
错误代码枚举。 |
ThrottledEntity
名称 |
类型 |
说明 |
currentRequests |
字符串 |
当前请求数 - 并发或速率。 |
debugMessage |
字符串 |
可用于调试的限制消息的人工可读版本。 |
LimitType |
字符串 |
限制类型,即并发或速率。 |
maxRequests |
字符串 |
允许的最大请求数 - 并发或速率。 |
periodInSeconds |
字符串 |
超出速率或并发限制时适用的时段(以秒为单位)。 |
版本 |
字符串 |
当前限制协定版本。 |