Back to Uni App

Object

docs/api/unicloud/object.md

2.3.35.0 KB
Original Source

importObject(objectName, options?) @importobject

引用云对象

importObject 兼容性

Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
4.04.41阿里云 3.9,腾讯云 3.91,支付宝云 3.984.114.61-

参数

名称类型必填默认值兼容性描述
objectNamestring (string.CloudObjectString)---
optionsUniCloudImportObjectOptions---

options 的属性描述

名称类型必备默认值兼容性描述
customUIboolean--是否移除自动展示的ui
loadingOptionsUniCloudImportObjectLoadingOptions--loading界面配置
errorOptionsUniCloudImportObjectErrorOptions--错误提示配置
secretMethodsany-Web: x; 微信小程序: 4.41; Android: 4.71; iOS: 4.71; HarmonyOS: x; HarmonyOS(Vapor): -指定方法的加密类型
loadingOptions 的属性描述
名称类型必备默认值兼容性描述
titlestring--加载框标题
maskboolean--加载框是否显示mask
errorOptions 的属性描述
名称类型必备默认值兼容性描述
typestring--错误提示类型,可以是modal或者toast
retryboolean--是否显示重试按钮

返回值

类型
UniCloudCloudObjectCaller

UniCloudCloudObjectCaller 的属性描述

名称类型必备默认值兼容性描述
_objInternalUniCloudCloudObject---
InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values
callMethod<T = UTSJSONObject>(methodName: string, args: Array<any | null>): Promise<T>; @callmethod

callMethod

callMethod 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
------
参数
名称类型必填默认值兼容性描述
methodNamestring---
argsArray<any>---
返回值
类型
Promise<T>

UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values

_getArgs: protected _getArgs(...args: Array<any | null>): Array<any | null>; @_getargs

_getArgs

_getArgs 兼容性
Web微信小程序AndroidiOSHarmonyOSHarmonyOS(Vapor)
------
参数
名称类型必填默认值兼容性描述
argsArray<any>---
返回值
类型
Array<any>

参见

uni-app x内使用云对象的特殊说明@strictly-typed-object

由于强类型语言的限制,uni-app-x在编译时需要读取本地云对象导出的方法列表生成客户端对象。

  • 请确保调用的云对象在本地包含导出的方法。
  • 请确保本地工程的云对象的方法是正确的。
  • 如由于云函数加密等因素导致index.obj.js无法被正确解析,请在云对象目录创建index.obj.d.ts声明云对象内包含的方法。index.obj.d.ts示例代码如下:
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
}
<!-- UTSUNICLOUDAPIJSON.unicloud-import-object.example -->

调用云对象时传入泛型

4.13版本起支持,仅安卓端会构造对应的泛型的实例,web端和iOS端泛型仅作为类型使用。

用法:obj.add<泛型类型>()

在不传泛型时云对象方法返回的类型为Promise<UTSJSONObject>,传入泛型后callFunction返回的类型为Promise<泛型类型>

代码示例

ts
// 云对象todo代码
'use strict';
module.exports = {
  async add(title, content) {
    return {
      errCode: 0,
      errMsg: '',
      detail: `Todo added, title: ${title}, content: ${content}`
    }
  },
}
ts
// 客户端代码
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)
})