docs/api/unicloud/object.md
引用云对象
| Web | 微信小程序 | Android | iOS | HarmonyOS | HarmonyOS(Vapor) |
|---|---|---|---|---|---|
| 4.0 | 4.41 | 阿里云 3.9,腾讯云 3.91,支付宝云 3.98 | 4.11 | 4.61 | - |
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| objectName | string (string.CloudObjectString) | 是 | - | - | - |
| options | UniCloudImportObjectOptions | 否 | - | - | - |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| customUI | boolean | 否 | - | - | 是否移除自动展示的ui |
| loadingOptions | UniCloudImportObjectLoadingOptions | 否 | - | - | loading界面配置 |
| errorOptions | UniCloudImportObjectErrorOptions | 否 | - | - | 错误提示配置 |
| secretMethods | any | 否 | - | Web: x; 微信小程序: 4.41; Android: 4.71; iOS: 4.71; HarmonyOS: x; HarmonyOS(Vapor): - | 指定方法的加密类型 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| title | string | 否 | - | - | 加载框标题 |
| mask | boolean | 否 | - | - | 加载框是否显示mask |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| type | string | 否 | - | - | 错误提示类型,可以是modal或者toast |
| retry | boolean | 否 | - | - | 是否显示重试按钮 |
| 类型 |
|---|
| UniCloudCloudObjectCaller |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| _obj | InternalUniCloudCloudObject | 是 | - | - | - |
callMethod
| Web | 微信小程序 | Android | iOS | HarmonyOS | HarmonyOS(Vapor) |
|---|---|---|---|---|---|
| - | - | - | - | - | - |
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| methodName | string | 是 | - | - | - |
| args | Array<any> | 是 | - | - | - |
| 类型 |
|---|
| Promise<T> |
_getArgs
| Web | 微信小程序 | Android | iOS | HarmonyOS | HarmonyOS(Vapor) |
|---|---|---|---|---|---|
| - | - | - | - | - | - |
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| args | Array<any> | 否 | - | - | - |
| 类型 |
|---|
| Array<any> |
由于强类型语言的限制,uni-app-x在编译时需要读取本地云对象导出的方法列表生成客户端对象。
index.obj.js无法被正确解析,请在云对象目录创建index.obj.d.ts声明云对象内包含的方法。index.obj.d.ts示例代码如下:// index.obj.d.ts
type AnyFunction = (...args: any[]) => any;
declare const add: AnyFunction
declare const update: AnyFunction
declare const deleteRecord: AnyFunction
export { // 上面的写法可以自己调整,仅需保证export内包含所有方法即可
add,
update
deleteRecord as remove
}
4.13版本起支持,仅安卓端会构造对应的泛型的实例,web端和iOS端泛型仅作为类型使用。
用法:obj.add<泛型类型>()
在不传泛型时云对象方法返回的类型为Promise<UTSJSONObject>,传入泛型后callFunction返回的类型为Promise<泛型类型>
代码示例
// 云对象todo代码
'use strict';
module.exports = {
async add(title, content) {
return {
errCode: 0,
errMsg: '',
detail: `Todo added, title: ${title}, content: ${content}`
}
},
}
// 客户端代码
const todo = uniCloud.importObject('todo')
type CallObjectResult = {
errCode : number
errMsg : string
detail : string
}
todo.add<CallObjectResult>('todo title', 'todo content').then((res) => {
const detail = res.detail // res类型为CallObjectResult,可直接通过.detail访问其中detail属性
console.log(detail)
}).catch((err : any | null) => {
console.error(err)
})