tt.reportLiveChallengeScore
基础库 3.55.0 开始支持本方法,这是一个异步方法。
直播挑战赛专用 API,用于上报直播挑战赛分数,使用前请咨询平台
前提条件 | 使用前请咨询平台 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
支持沙盒 | 否 |
相关教程 | https://bytedance.larkoffice.com/docx/QfaRdjgoboQWjQxaof0cEIGWnie |
语法
tt.reportLiveChallengeScore(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
id | string | 是 | 挑战赛的唯一 ID,每局不能重复 | 3.55.0 | |
score | string | 是 | 挑战赛分数 | 3.55.0 | |
status | enum | 是 | 挑战赛状态 | 3.55.0 | |
success | function | 否 | 接口调用成功的回调函数 | 3.55.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.55.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.55.0 |
status 的合法值
值 | 说明 | 最低支持版本 |
---|---|---|
1 | 挑战开始 | 3.55.0 |
2 | 挑战结束 | 3.55.0 |
3 | 挑战进行中 | 3.55.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "reportLiveChallengeScore:ok" | 3.55.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "reportLiveChallengeScore:fail " + 错误信息 | 3.55.0 |
代码示例
tt.reportLiveChallengeScore({ id: 'test1', status: 1, score: '123', success() { }, fail() { } });