• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • 标准对象输入
  • 用户授权
  • 参数调起使用场景描述
  • 标准对象输入
    收藏
    我的收藏

    定义 API 的标准输入内容。 绝大多数 API 为异步调用,调用的结果通过预先定义好的三个 callback 方法返回

    success (res)

    当 API 成功执行后调用,传入参数resobject类型,基础属性包括:

    名称数据类型描述
    errMsgstring预定义返回消息格式为${API_NAME}:ok

    API 执行的返回结果会扩展 res 的属性,具体参见各 API 详细说明。

    fail (res)

    当 API 执行失败后调用,传入参数resobject类型,基础属性包括:

    名称数据类型描述
    errMsgstring预定义返回消息格式为${API_NAME}:fail

    API 执行的返回结果会扩展 res 的属性,具体参见各 API 详细说明。

    complete (res)

    当 API 执行完成(无论成功或者失败)后调用,传入参数resobject类型,基础属性包括:

    名称数据类型描述
    errMsgstringsuccessfail的值相同

    API 执行的返回结果会扩展 res 的属性,具体参见各 API 详细说明。

    提示

    complete回调的执行发生在successfail之后。

    代码示例

    var someSwitch = "on"; Page({ oneFunc() { if (someSwitch === "on") { someSwitch = "off"; tt.someAPI({ someattr: somevalue, success(res) { console.log(res.someattr); }, fail(res) { console.log(`run fail`); }, complete(res) { console.log(`run done`); someSwitch = "on"; }, }); } }, });

    该文档是否有帮助?