tt.getUserCloudStorage
收藏我的收藏
基础库 1.11.0 开始支持本方法,这是一个异步方法。
获取当前用户托管数据当中对应 key 的数据。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 该接口只可在开放数据域下使用 |
| 注意事项 | 无 |
| 相关教程 | 无 |
语法
tt.getUserCloudStorage(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| keyList | Array<string> | 是 | 要获取的 key 列表 | 1.11.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.11.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.11.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.11.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| KVDataList | array | 用户托管的 KV 数据列表。数据类型为 KVData 类型 | 1.11.0 |
| errMsg | string | "getUserCloudStorage:ok" | 1.11.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "setUserCloudStorage:fail" + 详细错误信息 | 1.11.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 21000 | get session id failed. | 1.11.0 | |
| 10301 | feature is not supported in app | 1.11.0 | |
| 20000 | keyList is null | 1.11.0 | |
| 21000 | * | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 21000 | response json doesn't have `data` field | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 10401 | internal error/网络请求非200 | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
| 10103 | network unavailable | 1.11.0 | |
| 20000 | internal error | 小游戏框架内部错误,有需要请创建工单咨询 | 1.11.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.getUserCloudStorage({ keyList: ["xxx"], // 要获取的 key 列表 success: (res) => { console.log("调用成功"); console.log(res.KVDataList); }, fail: (res) => { console.log("调用失败"); }, complete: (res) => { console.log("调用完成"); }, });
