npm - tmui-cli - Versions diffs - 2.0.5 → 5.3.1 - Mend

tmui-cli 2.0.5 → 5.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (777) hide show

package/data/uni-app-x-docs/.vuepress/utils/utsUnicloudApiJson.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"uniCloud_props":{"name":"# uniCloud","description":"","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \| 兼容性 \| 描述 \|\n\| :- \| :- \| :- \| :-: \| :- \|\n\| config \| UniCloudInitOptions \| 是 \| \| \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| provider \| string \| 是 \| 服务商，目前支持 aliyun、tencent、alipay \|\n@\| spaceName \| string \| 否 \| 服务空间名 \|\n@\| spaceId \| string \| 是 \| 服务空间id \|\n@\| clientSecret \| string \| 否 \| 阿里云clientSecret \|\n@\| endpoint \| string \| 否 \| 阿里云endpoint \|\n@\| spaceAppId \| string \| 否 \| 支付宝云spaceAppId \|\n@\| accessKey \| string \| 否 \| 支付宝云accessKey \|\n@\| secretKey \| string \| 否 \| 支付宝云secretKey \|\n@\| wsEndpoint \| string \| 否 \| 支付宝云 WebSocket Endpoint \|\n\| mixinDatacom \| any \| 是 \| \| \|\n\| SSEChannel \| [SSEChannel](#ssechannel-values) \| 是 \| <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"微信小程序\"},{\"title\":\"Android\"},{\"title\":\"iOS\"},{\"title\":\"HarmonyOS\"}],\"rows\":[[\"4.71\",\"4.71\",\"4.71\",\"4.71\",\"4.71\"]],\"status\":\"SUPPORTED\"}' /> \| 服务端通知通道 \| \n\n### SSEChannel 的方法 @ssechannel-values \n\n### open(): Promise\\<void>; @open\nopen\n开启通道，注意只有开启之后才能把SSEChannel实例传入云函数\n\n\n\n#### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<void> \|\n \n\n### toJSON(): { appId: string; pushClientId: string; seqId: string; }; @tojson\ntoJSON\n\n\n\n\n#### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [{ appId: string; pushClientId: string; seqId: string; }](#appid-values) \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| appId \| string \| 是 \|\n@\| pushClientId \| string \| 是 \|\n@\| seqId \| string \| 是 \| \n\n### close(): void; @close\nclose\n关闭通道\n\n\n\n\n### on(event: 'message', callback: (message: string) => void): void; @on\non\n监听消息接收事件\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| event \| string \| 是 \|\n\| callback \| (message: string) => void \| 是 \| \n\n\n\n### off(event: 'message', callback: (message: string) => void): void; @off\noff\n取消监听消息接收事件\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| event \| string \| 是 \|\n\| callback \| (message: string) => void \| 是 \| \n\n\n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"::: sourceCode\n## callFunction(options) @callfunction\n:::","originName":"callFunction","description":"请求云函数","compatibility":"### callFunction 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| UniCloudCallFunctionOptions \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 兼容性 \| 描述 \|\n@\| :- \| :- \| :- \| :-: \| :- \|\n@\| name \| string ([string.CloudFunctionString](/uts/data-type.md#ide-string)) \| 是 \| \| 云函数名 \|\n@\| data \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \| 云函数参数 \|\n@\| secretType \| string \| 否 \| <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"微信小程序\"},{\"title\":\"Android\"},{\"title\":\"iOS\"},{\"title\":\"HarmonyOS\"}],\"rows\":[[\"x\",\"4.41\",\"4.71\",\"4.71\",\"x\"]],\"status\":\"PARTIALLY_SUPPORTED\"}' /> \| 加密类型，指定加密请求、响应还是都加密 \|\n@@\| 合法值 \| 兼容性 \|\n@@\| :- \| :-: \|\n@@\| 'request' \| <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"微信小程序\"},{\"title\":\"Android\"},{\"title\":\"iOS\"},{\"title\":\"HarmonyOS\"}],\"rows\":[[\"x\",\"4.41\",\"4.71\",\"4.71\",\"x\"]],\"status\":\"PARTIALLY_SUPPORTED\"}' /> \|\n@@\| response \| \|\n@@\| both \| \|\n@@\| none \| \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudCallFunctionResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| result \| [UniCloudCallFunctionResult](#unicloudcallfunctionresult-values) \| 是 \| 云函数返回结果 \|\n@\| requestId \| string \| 否 \| 云函数请求id \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudFunction.callFunction)"},"cloudFunction":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/cloud-function.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/cloud-function.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-function\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-function\n\n>示例\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view cloud-function-page uni-theme-root\">\r\n <!-- #endif -->\r\n <view class=\"cloud-function-page uni-theme-root\">\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"callFunction\">请求云函数</button>\r\n <button type=\"primary\" @click=\"callFunctionWithGeneric\">请求云函数传入泛型</button>\r\n <!-- #ifdef APP-ANDROID \|\| APP-IOS -->\r\n <button type=\"primary\" @click=\"callEncryptionFunction\">请求安全网络加密云函数</button>\r\n <button type=\"primary\" @click=\"callVerifyFunction\">请求安全网络客户端校验云函数</button>\r\n <view><text class=\"tips\">安全网络相关功能需要打包自定义基座方可正常使用</text></view>\r\n <!-- #endif -->\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n<script setup lang=\"uts\">\r\n\r\n\r\ntype DataType = {\r\n callFunctionResult: UTSJSONObject,\r\n callFunctionResult_Detail_functionName: string,\r\n callFunctionError: UTSJSONObject,\r\n genericDemoShowMessage: string,\r\n isUniTest: boolean,\r\n}\r\n\r\nconst title = ref('请求云函数')\r\nconst data = reactive({\r\n callFunctionResult: {} as UTSJSONObject,\r\n callFunctionResult_Detail_functionName: '',\r\n callFunctionError: {} as UTSJSONObject,\r\n genericDemoShowMessage: '',\r\n isUniTest: false,\r\n} as DataType)\r\n\r\nfunction notify(content : string, title : string) {\r\n if (!data.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n}\r\n\r\nasync function callFunctionWithGeneric(): Promise<void> {\r\n type EchoCfResult = {\r\n showMessage : string\r\n }\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n await uniCloud.callFunction<EchoCfResult>({\r\n name: 'echo-cf',\r\n data: {\r\n num: 1,\r\n str: 'ABC'\r\n }\r\n }).then(res => {\r\n const result = res.result\r\n uni.hideLoading()\r\n data.genericDemoShowMessage = result.showMessage\r\n notify(result.showMessage, '提示')\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n } as UTSJSONObject\r\n uni.hideLoading()\r\n notify(error.errMsg, '错误')\r\n })\r\n}\r\n\r\nasync function callFunction(): Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n await uniCloud.callFunction({\r\n name: 'echo-cf',\r\n data: {\r\n num: 1,\r\n str: 'ABC'\r\n }\r\n }).then(res => {\r\n const result = res.result\r\n data.callFunctionResult = result\r\n const detail = result.get('detail') as UTSJSONObject\r\n data.callFunctionResult_Detail_functionName = detail.get('functionName') as string\r\n console.log('callFunctionResult_Detail_functionName: ' + data.callFunctionResult_Detail_functionName)\r\n uni.hideLoading()\r\n notify(result['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n uni.hideLoading()\r\n if(err instanceof UniCloudError) {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n } as UTSJSONObject\r\n notify(error.errMsg, '错误')\r\n } else {\r\n console.error(err)\r\n }\r\n })\r\n}\r\n\r\nfunction callEncryptionFunction() {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n uniCloud.callFunction({\r\n name: 'encryption',\r\n data: {},\r\n secretType: 'both'\r\n }).then(res => {\r\n uni.hideLoading()\r\n notify(JSON.stringify(res.result), '提示')\r\n }).catch((err : any \| null) => {\r\n uni.hideLoading()\r\n if(err instanceof UniCloudError) {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n } as UTSJSONObject\r\n notify(error.errMsg, '错误')\r\n } else {\r\n console.error(err)\r\n }\r\n })\r\n}\r\n\r\nfunction callVerifyFunction() {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n uniCloud.callFunction({\r\n name: 'verify-client',\r\n data: {},\n secretType: 'both'\r\n }).then(res => {\r\n uni.hideLoading()\r\n notify(JSON.stringify(res.result), '提示')\r\n }).catch((err : any \| null) => {\r\n uni.hideLoading()\r\n if(err instanceof UniCloudError) {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n } as UTSJSONObject\r\n notify(error.errMsg, '错误')\r\n } else {\r\n console.error(err)\r\n }\r\n })\r\n}\r\n\r\nfunction jest_UniCloudError() {\r\n return new Error() instanceof UniCloudError\r\n}\r\n\r\nonLoad((options : OnLoadOptions) => {\r\n})\r\n\r\nonUnload(() => {\r\n if (data.isUniTest) {\r\n uni.hideToast()\r\n }\r\n})\r\n\r\ndefineExpose({\r\n data,\r\n callFunction,\r\n callFunctionWithGeneric,\r\n jest_UniCloudError\r\n})\r\n</script>\r\n\r\n<style>\r\n .cloud-function-page {\r\n --cloud-function-hint-color: #999999;\r\n }\r\n\r\n .tips {\r\n color: var(--cloud-function-hint-color, #999999);\r\n font-size: 12px;\r\n padding: 10px 0px;\r\n }\r\n\r\n @media (prefers-color-scheme: dark) {\r\n .cloud-function-page {\r\n --cloud-function-hint-color: #a0a0a0;\r\n }\r\n }\r\n</style>\r\n\n```\n\n:::"},"importObject":{"name":"::: sourceCode\n## importObject(objectName, options?) @importobject\n:::","originName":"importObject","description":"引用云对象","compatibility":"### importObject 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| objectName \| string ([string.CloudObjectString](/uts/data-type.md#ide-string)) \| 是 \|\n\| options \| UniCloudImportObjectOptions \| 否 \|\n@\| 名称 \| 类型 \| 必备 \| 兼容性 \| 描述 \|\n@\| :- \| :- \| :- \| :-: \| :- \|\n@\| customUI \| boolean \| 否 \| \| 是否移除自动展示的ui \|\n@\| loadingOptions \| UniCloudImportObjectLoadingOptions \| 否 \| \| loading界面配置 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| title \| string \| 否 \| 加载框标题 \|\n@@\| mask \| boolean \| 否 \| 加载框是否显示mask \|\n@\| errorOptions \| UniCloudImportObjectErrorOptions \| 否 \| \| 错误提示配置 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| type \| string \| 否 \| 错误提示类型，可以是modal或者toast \|\n@@\| retry \| boolean \| 否 \| 是否显示重试按钮 \|\n@\| secretMethods \| Record\\<K, T> \| 否 \| <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"微信小程序\"},{\"title\":\"Android\"},{\"title\":\"iOS\"},{\"title\":\"HarmonyOS\"}],\"rows\":[[\"x\",\"4.41\",\"4.71\",\"4.71\",\"x\"]],\"status\":\"PARTIALLY_SUPPORTED\"}' /> \| 指定方法的加密类型 \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudCloudObjectCaller](#unicloudcloudobjectcaller-values) \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| _obj \| [InternalUniCloudCloudObject](#internalunicloudcloudobject-values) \| 是 \|\n##### InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values \n\n##### callMethod\\<T = UTSJSONObject>(methodName: string, args: Array\\<any>): Promise\\<T>; @callmethod\ncallMethod\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| methodName \| string \| 是 \|\n\| args \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<T> \|\n \n\n#### UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values \n\n#### _getArgs: protected _getArgs(...args: Array\\<any>): Array\\<any \\\| null>; @_getargs\n_getArgs\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<any> \| 否 \| \n\n\n##### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Array<any> \|\n \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudObject.importObject)"},"cloudObject":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/cloud-object.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/cloud-object.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-object\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-object\n\n>示例\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodo\">添加Todo</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodoWithGeneric\">\r\n 添加Todo传入泛型\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"randomFail\">随机触发失败重试</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"fail\">云对象失败调用</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"failWithNumberErrCode\">\r\n 云对象数字错误码\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"success\">云对象成功调用</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n<script setup lang=\"uts\">\r\n\r\n\r\n type DataType = {\r\n todoTitle: string,\r\n todoContent: string,\r\n returnTodoTitle: string,\r\n returnTodoContent: string,\r\n genericDemoReturnTodoTitle: string,\r\n genericDemoReturnTodoContent: string,\r\n failErrCode: string,\r\n failErrSubject: string,\r\n failErrDetailTips: string,\r\n failNumberErrCode: number,\r\n successErrCode: number,\r\n isUniTest: boolean,\r\n }\r\n\r\n // Data\r\n const title = ref('请求云对象')\r\n const data = reactive({\r\n todoTitle: '学习编程',\r\n todoContent: '熟悉uts语法',\r\n returnTodoTitle: '',\r\n returnTodoContent: '',\r\n genericDemoReturnTodoTitle: '',\r\n genericDemoReturnTodoContent: '',\r\n failErrCode: '',\r\n failErrSubject: '',\r\n failErrDetailTips: '',\r\n failNumberErrCode: 0,\r\n successErrCode: -1,\r\n isUniTest: false,\r\n } as DataType)\r\n\r\n // Functions\r\n function notify(content : string, title : string) {\r\n if (!data.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n }\r\n\r\n async function addTodo() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n const title = data.todoTitle\r\n const content = data.todoContent\r\n await todo.add<UTSJSONObject>(title, content).then((res : UTSJSONObject) => {\r\n data.returnTodoTitle = res['title'] as string\r\n data.returnTodoContent = res['content'] as string\r\n notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n\r\n async function addTodoWithGeneric() : Promise<void> {\r\n type AddTodoResult = {\r\n title : string,\r\n content : string,\r\n showMessage : string\r\n }\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n const title = data.todoTitle\r\n const content = data.todoContent\r\n await todo.add<AddTodoResult>(title, content).then((res : AddTodoResult) => {\r\n data.genericDemoReturnTodoTitle = res.title\r\n data.genericDemoReturnTodoContent = res.content\r\n notify(res.showMessage, '提示')\r\n }).catch((err : any \| null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n\r\n async function randomFail() : Promise<void> {\r\n const todoObj = uniCloud.importObject('todo', {\r\n errorOptions: {\r\n retry: true\r\n }\r\n })\r\n await todoObj.randomFail().then((res : UTSJSONObject) => {\r\n notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n console.log(error)\r\n })\r\n }\r\n\r\n async function fail() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n await todo.fail().then((res : UTSJSONObject) => {\r\n notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n data.failErrCode = error.errCode as string\r\n data.failErrSubject = error.errSubject as string\r\n const detail = error.detail\r\n if (detail != null && detail['tips'] != null) {\r\n data.failErrDetailTips = detail['tips'] as string\r\n }\r\n console.log(error)\r\n })\r\n }\r\n\r\n async function failWithNumberErrCode() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n await todo.failWithNumberErrCode().then((res : UTSJSONObject) => {\r\n notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n data.failNumberErrCode = error.errCode as number\r\n console.log(error)\r\n })\r\n }\r\n\r\n async function success() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n await todo.success().then((res : UTSJSONObject) => {\r\n data.successErrCode = res['errCode'] as number\r\n notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n\r\n defineExpose({\r\n data,\r\n addTodo,\r\n addTodoWithGeneric,\r\n fail,\r\n failWithNumberErrCode,\r\n success\r\n })\r\n</script>\r\n\r\n<style></style>\r\n\n```\n\n:::"},"uploadFile":{"name":"::: sourceCode\n## uploadFile(options) @uploadfile\n:::","originName":"uploadFile","description":"上传文件到云存储","compatibility":"### uploadFile 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| filePath \| string \| 是 \| 文件路径 \|\n@\| cloudPath \| string \| 是 \| 云端路径 \|\n@\| cloudPathAsRealPath \| boolean \| 否 \| 是否以云端路径是否为真实路径保存上传的文件 \| \n\n### UniCloudUploadFileOptions 的方法 @uniclouduploadfileoptions-values \n\n### onUploadProgress: (options: UniCloudUploadProgress) => any @onuploadprogress\nonUploadProgress\n上传进度回调\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| options \| UniCloudUploadProgress \| 是 \| 上传进度回调参数 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| loaded \| number \| 是 \| 已上传大小 \|\n@\| total \| number \| 是 \| 总大小 \| \n\n\n#### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| any \|\n \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudUploadFileResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| filePath \| string \| 是 \| 文件路径 \|\n@\| fileID \| string \| 是 \| 文件id \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.uploadFile)"},"getTempFileURL":{"name":"::: sourceCode\n## getTempFileURL(options) @gettempfileurl\n:::","originName":"getTempFileURL","description":"获取文件临时URL","compatibility":"### getTempFileURL 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| UniCloudGetTempFileURLOptions \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| fileList \| Array<string> \| 是 \| 文件列表 \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudGetTempFileURLResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| fileList \| Array<UniCloudGetTempFileURLResultItem> \| 是 \| 文件列表 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| fileID \| string \| 是 \| 文件id \|\n@@\| tempFileURL \| string \| 是 \| 文件临时url \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.chooseAndUploadFile)"},"chooseAndUploadFile":{"name":"::: sourceCode\n## chooseAndUploadFile(options) @chooseanduploadfile\n:::","originName":"chooseAndUploadFile","description":"选择并上传文件","compatibility":"### chooseAndUploadFile 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) \| 是 \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| sourceType \| Array<string> \| 否 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| album \|\n@@\| camera \|\n@\| count \| number \| 否 \|\n@\| sizeType \| Array<string> \| 否 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| original \|\n@@\| compressed \|\n@\| extension \| Array<string> \| 否 \|\n@\| compressed \| boolean \| 否 \|\n@\| maxDuration \| number \| 否 \|\n@\| camera \| string \| 否 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| front \|\n@@\| back \|\n@\| crop \| ChooseImageCropOptions \| 否 \|\n@\| type \| string \| 是 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| image \|\n@@\| video \|\n@@\| all \| \n\n### UniCloudChooseAndUploadFileOptions 的方法 @unicloudchooseanduploadfileoptions-values \n\n### onChooseFile: (arg: UniCloudChooseAndUploadFileResult) => void \\\| null @onchoosefile\nonChooseFile\n\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| UniCloudChooseAndUploadFileResult \| 是 \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| tempFiles \| Array<UniCloudChooseAndUploadFileItem> \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \|\n@@\| :- \| :- \| :- \|\n@@\| name \| string \| 是 \|\n@@\| path \| string \| 是 \|\n@@\| cloudPath \| string \| 是 \|\n@@\| cloudPathAsRealPath \| boolean \| 否 \|\n@@\| url \| string \| 否 \|\n@@\| errMsg \| string \| 否 \|\n@\| tempFilePaths \| Array<string> \| 是 \| \n\n\n\n### onUploadProgress: (arg: UniCloudChooseAndUploadFileProgressEvent) => void \\\| null @onuploadprogress\nonUploadProgress\n\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| UniCloudChooseAndUploadFileProgressEvent \| 是 \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| index \| number \| 是 \|\n@\| loaded \| number \| 是 \|\n@\| total \| number \| 是 \|\n@\| tempFilePath \| string \| 是 \|\n@\| tempFile \| UniCloudChooseAndUploadFileItem \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \|\n@@\| :- \| :- \| :- \|\n@@\| name \| string \| 是 \|\n@@\| path \| string \| 是 \|\n@@\| cloudPath \| string \| 是 \|\n@@\| cloudPathAsRealPath \| boolean \| 否 \|\n@@\| url \| string \| 否 \|\n@@\| errMsg \| string \| 否 \| \n\n\n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudChooseAndUploadFileResult> \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| tempFiles \| Array<UniCloudChooseAndUploadFileItem> \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \|\n@@\| :- \| :- \| :- \|\n@@\| name \| string \| 是 \|\n@@\| path \| string \| 是 \|\n@@\| cloudPath \| string \| 是 \|\n@@\| cloudPathAsRealPath \| boolean \| 否 \|\n@@\| url \| string \| 否 \|\n@@\| errMsg \| string \| 否 \|\n@\| tempFilePaths \| Array<string> \| 是 \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.getTempFileURL)"},"cloudStorage":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/cloud-storage.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/cloud-storage.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-storage\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-storage\n\n>示例\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"uploadFile\">选择文件上传</button>\r\n <button type=\"primary\" @click=\"chooseAndUploadFile\">一个接口选择文件并上传</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n<script setup lang=\"uts\">\r\n\r\n\r\n // Data\r\n const title = ref('云存储')\r\n\r\n // Functions\r\n function uploadFile() {\r\n uni.chooseImage({\r\n count: 1,\r\n success(res) : void {\r\n uni.showLoading({\r\n title: '上传中...'\r\n })\r\n const tempFilePath = res.tempFilePaths[0]\r\n uniCloud.uploadFile({\r\n filePath: tempFilePath,\r\n cloudPath: 'test.jpg'\r\n })\r\n .then(function (res) {\r\n uni.hideLoading()\r\n uni.showModal({\r\n content: '上传成功',\r\n showCancel: false\r\n });\r\n })\r\n .catch(function (err : any \| null) {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n uni.showModal({\r\n content: '上传失败，' + error.errMsg,\r\n showCancel: false\r\n });\r\n })\r\n // .finally((_: number) : void => {\r\n // uni.hideLoading()\r\n // })\r\n },\r\n fail(err) : void {\r\n console.error('chooseImage fail: ', err)\r\n }\r\n })\r\n }\r\n\r\n function chooseAndUploadFile() {\r\n uniCloud.chooseAndUploadFile({\r\n type: 'image'\r\n }).then(function (res) {\r\n uni.hideLoading()\r\n uni.showModal({\r\n content: '上传成功',\r\n showCancel: false\r\n });\r\n })\r\n .catch(function (err : any \| null) {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n uni.showModal({\r\n content: '上传失败，' + error.errMsg,\r\n showCancel: false\r\n });\r\n })\r\n }\r\n</script>\r\n\r\n<style>\r\n</style>\r\n\n```\n\n:::"},"databaseForJQL":{"name":"::: sourceCode\n## databaseForJQL() @databaseforjql\n:::","originName":"databaseForJQL","description":"获取数据库操作实例","compatibility":"### databaseForJQL 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.91，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [Database](#database-values) \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| command \| [UniCloudDBCommand](#uniclouddbcommand-values) \| 是 \|\n@\| Geo \| UniCloudDBGeo \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| Point \| GeoPoint \| 是 \| 地理位置点 \|\n@@\| LineString \| GeoLineString \| 是 \| 地理路径，是由两个或者更多的 Point 组成的线段 \|\n@@\| Polygon \| GeoPolygon \| 是 \| 地理上的一个多边形（有洞或无洞均可），它是由一个或多个闭环 LineString 组成的几何图形 \|\n@@\| MultiPoint \| GeoMultiPoint \| 是 \| 多个地理位置点 Point 的集合 \|\n@@\| MultiLineString \| GeoMultiLineString \| 是 \| 多个地理路径 LineString 的集合 \|\n@@\| MultiPolygon \| GeoMultiPolygon \| 是 \| 多个地理多边形 Polygon 的集合 \|\n##### UniCloudDBCommand 的方法 @uniclouddbcommand-values \n\n##### and(args: Array\\<UTSJSONObject>): UTSJSONObject; @and\nand\n查询操作符，用于表示逻辑 \"与\" 的关系，表示需同时满足多个查询筛选条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### or(args: Array\\<UTSJSONObject>): UTSJSONObject; @or\nor\n查询操作符，用于表示逻辑 \"或\" 的关系，表示需同时满足多个查询筛选条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### not(arg: UTSJSONObject): UTSJSONObject; @not\nnot\n查询操作符，用于表示逻辑 \"非\" 的关系，表示需不满足指定的条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### nor(args: Array\\<UTSJSONObject>): UTSJSONObject; @nor\nnor\n查询操作符，用于表示逻辑 \"都不\" 的关系，表示需不满足指定的所有条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### eq(arg: any): UTSJSONObject; @eq\neq\n查询筛选条件，表示字段等于某个值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### neq(arg: any): UTSJSONObject; @neq\nneq\n查询筛选条件，表示字段不等于某个值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### lt(arg: any): UTSJSONObject; @lt\nlt\n查询筛选操作符，表示需小于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### lte(arg: any): UTSJSONObject; @lte\nlte\n查询筛选操作符，表示需小于或等于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### gt(arg: any): UTSJSONObject; @gt\ngt\n查询筛选操作符，表示需大于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### gte(arg: any): UTSJSONObject; @gte\ngte\n查询筛选操作符，表示需大于或等于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### in(arr: Array\\<any>): UTSJSONObject; @in\nin\n查询筛选操作符，表示要求值在给定的数组内\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arr \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### nin(arr: Array\\<any>): UTSJSONObject; @nin\nnin\n查询筛选操作符，表示要求值不在给定的数组内\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arr \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### exists(arg: boolean): UTSJSONObject; @exists\nexists\n判断字段是否存在\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| boolean \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### mod(divisor: number, remainder: number): UTSJSONObject; @mod\nmod\n查询筛选操作符，给定除数 divisor 和余数 remainder\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| divisor \| number \| 是 \| 除数 \|\n\| remainder \| number \| 是 \| 余数 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### all(arr: Array\\<any>): UTSJSONObject; @all\nall\n数组查询操作符。用于数组字段的查询筛选条件，要求数组字段中包含给定数组的所有元素\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arr \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### elemMatch(arg: UTSJSONObject): UTSJSONObject; @elemmatch\nelemMatch\n用于数组字段的查询筛选条件，要求数组中包含至少一个满足 elemMatch 给定的所有条件的元素\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### size(arg: number): UTSJSONObject; @size\nsize\n更新操作符，用于数组字段的查询筛选条件，要求数组长度为给定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### geoNear(arg: UTSJSONObject): UTSJSONObject; @geonear\ngeoNear\n按从近到远的顺序，找出字段值在给定点的附近的记录\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### geoWithin(arg: UTSJSONObject): UTSJSONObject; @geowithin\ngeoWithin\n找出字段值在指定区域内的记录，无排序。指定的区域必须是多边形（Polygon）或多边形集合（MultiPolygon）\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### geoIntersects(arg: UTSJSONObject): UTSJSONObject; @geointersects\ngeoIntersects\n找出给定的地理位置图形相交的记录\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n#### Database 的方法 @database-values \n\n#### collection(...args: Array\\<any>): Collection; @collection\ncollection\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<any> \| 否 \| \n\n\n##### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [Collection](#collection-values) \|\n\n###### Collection 的方法 @collection-values \n\n###### where(condition: any): UniCloudDBFilter; @where\nwhere\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| condition \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n\n###### UniCloudDBFilter 的方法 @uniclouddbfilter-values \n\n###### get(arg?: UTSJSONObject): Promise\\<UniCloudDBGetResult>; @get\nget\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBGetResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| 添加的记录的id列表 \|\n@\| count \| number \| 否 \| 匹配到的数据总量 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\ncount\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBCountResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| total \| number \| 是 \| 添加的记录的id列表 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### update(data: UTSJSONObject): Promise\\<UniCloudDBUpdateResult>; @update\nupdate\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| data \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBUpdateResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| updated \| number \| 是 \| 更新成功的记录数 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### remove(): Promise\\<UniCloudDBRemoveResult>; @remove\nremove\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBRemoveResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| deleted \| number \| 是 \| 删除成功的记录数 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### getTemp(): UTSJSONObject; @gettemp\ngetTemp\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n###### where(condition: any): UniCloudDBFilter; @where\nwhere\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| condition \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBFilter \|\n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\ndoc\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| docId \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBFilter \|\n \n\n###### field(filed: string): UniCloudDBQuery; @field\nfield\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| filed \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n\n###### UniCloudDBQuery 的方法 @uniclouddbquery-values \n\n###### get(arg?: UTSJSONObject): Promise\\<UniCloudDBGetResult>; @get\nget\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBGetResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| 添加的记录的id列表 \|\n@\| count \| number \| 否 \| 匹配到的数据总量 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\ncount\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBCountResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| total \| number \| 是 \| 添加的记录的id列表 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### getTemp(): UTSJSONObject; @gettemp\ngetTemp\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n###### field(filed: string): UniCloudDBQuery; @field\nfield\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| filed \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\nskip\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\nlimit\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\norderBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| order \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\ngroupBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\ngroupField\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\ndistinct\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\ngeoNear\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n \n\n###### skip(num: number): UniCloudDBQuery; @skip\nskip\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\nlimit\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\norderBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| order \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\ngroupBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\ngroupField\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\ndistinct\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\ngeoNear\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\ndoc\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| docId \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n \n\n###### aggregate(): UniCloudDBFilter; @aggregate\naggregate\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n \n\n###### foreignKey(foreignKey: string): UniCloudDBFilter; @foreignkey\nforeignKey\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| foreignKey \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n \n\n###### add(data: UTSJSONObject): Promise\\<UniCloudDBAddResult>; @add\nadd\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| data \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBAddResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| id \| string \| 是 \| 添加的记录的id \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### get(arg?: UTSJSONObject): Promise\\<UniCloudDBGetResult>; @get\nget\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBGetResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| 添加的记录的id列表 \|\n@\| count \| number \| 否 \| 匹配到的数据总量 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\ncount\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBCountResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| total \| number \| 是 \| 添加的记录的id列表 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### getTemp(): UTSJSONObject; @gettemp\ngetTemp\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n###### field(filed: string): UniCloudDBQuery; @field\nfield\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| filed \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\nskip\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\nlimit\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\norderBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| order \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n \n\n#### multiSend(...args: Array\\<UTSJSONObject>): Promise\\<UniCloudDBMultiSendResult>; @multisend\nmultiSend\n合并查询请求\n##### multiSend 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 4.16 \| 4.11 \| 4.61 \|\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 否 \| \n\n\n##### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBMultiSendResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| dataList \| Array<UniCloudDBMultiSendResultItem> \| 是 \| 数据列表 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| errCode \| any \| 是 \| 错误码，可能为字符串或数字，数字0表示成功 \|\n@@\| errMsg \| string \| 是 \| 错误信息 \|\n@@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 否 \| 数据 \|\n@\| requestId \| string \| 否 \| 请求id \| \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.database.databaseForJQL)"},"database":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/database.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/database.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/database\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/database\n\n>示例\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"dbAdd\">新增单条数据</button>\r\n <button type=\"primary\" @click=\"dbBatchAdd\">新增多条数据</button>\r\n <button type=\"primary\" @click=\"dbUpdate\">更新数据</button>\r\n <button type=\"primary\" @click=\"dbGet\">where传字符串获取数据</button>\r\n <button type=\"primary\" @click=\"dbGetWithCommand\">where传对象获取数据</button>\r\n <button type=\"primary\" @click=\"dbRemove\">删除数据</button>\r\n <button type=\"primary\" @click=\"dbLookupInit\">初始化联表查询数据</button>\r\n <button type=\"primary\" @click=\"dbLookup\">联表查询</button>\r\n <button type=\"primary\" @click=\"dbMultiSend\">合并查询查询</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n<script setup lang=\"uts\">\r\n\r\n\r\n type DataType = {\r\n addId: string,\r\n batchAddIds: Array<string>,\r\n batchAddinserted: number,\r\n updateUpdated: number,\r\n getData: Array<UTSJSONObject>,\r\n getWithCommandData: Array<UTSJSONObject>,\r\n removeDeleted: number,\r\n lookupData: Array<UTSJSONObject>,\r\n multiSendSuccessCount: number,\r\n isUniTest: boolean,\r\n }\r\n\r\n // Data\r\n const title = ref('ClientDB')\r\n const data = reactive({\r\n addId: '',\r\n batchAddIds: [] as Array<string>,\r\n batchAddinserted: 0,\r\n updateUpdated: 0,\r\n getData: [] as Array<UTSJSONObject>,\r\n getWithCommandData: [] as Array<UTSJSONObject>,\r\n removeDeleted: 0,\r\n lookupData: [] as Array<UTSJSONObject>,\r\n multiSendSuccessCount: 0,\r\n isUniTest: false,\r\n } as DataType)\r\n\r\n // Computed\r\n const dataTag = computed<string>(() => {\r\n return data.isUniTest ? 'default-tag' + Date.now() : 'default-tag'\r\n })\r\n\r\n // Functions\r\n function notify(content : string, title : string) {\r\n if (!data.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n }\r\n\r\n async function dbAdd() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .add({\r\n num: 1,\r\n tag: dataTag.value,\r\n date: new Date()\r\n })\r\n .then(res => {\r\n uni.hideLoading()\r\n data.addId = res.id\r\n notify(`新增成功，id: ${res.id}`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbBatchAdd() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .add([{\r\n num: 2,\r\n tag: dataTag.value,\r\n }, {\r\n num: 3,\r\n tag: dataTag.value,\r\n }])\r\n .then((res) => {\r\n uni.hideLoading()\r\n data.batchAddIds = res.ids\r\n data.batchAddinserted = res.inserted\r\n notify(`新增成功条数${res.inserted}, id列表: ${res.ids.join(',')}`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbGet() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${dataTag.value}\"`\r\n )\r\n .field('num, tag')\r\n .orderBy('num desc')\r\n .skip(1)\r\n .limit(2)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.getData = res.data\r\n notify(`获取成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbGetWithCommand() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where({\r\n num: db.command.gt(1),\r\n tag: dataTag.value\r\n })\r\n .field('num, tag')\r\n .orderBy('num desc')\r\n .skip(1)\r\n .limit(2)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.getWithCommandData = res.data\r\n notify(`获取成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbUpdate() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${dataTag.value}\"`\r\n )\r\n .update({\r\n num: 4\r\n })\r\n .then(res => {\r\n uni.hideLoading()\r\n data.updateUpdated = res.updated\r\n notify(`更新成功，更新了${res.updated}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbRemove() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${dataTag.value}\"`\r\n )\r\n .remove()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.removeDeleted = res.deleted\r\n notify(`删除成功，删掉了${res.deleted}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbLookupInit() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('local')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .remove()\r\n .then(() : Promise<UniCloudDBRemoveResult> => {\r\n return db.collection('foreign')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .remove()\r\n })\r\n .then(() : Promise<UniCloudDBBatchAddResult> => {\r\n return db.collection('local')\r\n .add([{\r\n id: \"local_1\",\r\n name: \"local_1_name\",\r\n tag: dataTag.value,\r\n foreign_id: \"foreign_1\"\r\n }, {\r\n id: \"local_2\",\r\n name: \"local_2_name\",\r\n tag: dataTag.value,\r\n foreign_id: \"foreign_2\"\r\n }])\r\n })\r\n .then(() : Promise<UniCloudDBBatchAddResult> => {\r\n return db.collection('foreign')\r\n .add([{\r\n id: \"foreign_1\",\r\n name: \"foreign_1_name\",\r\n tag: dataTag.value\r\n }, {\r\n id: \"foreign_2\",\r\n name: \"foreign_2_name\",\r\n tag: dataTag.value\r\n }])\r\n })\r\n .then((_) : void => {\r\n uni.hideLoading()\r\n notify('数据初始化成功', '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n console.error(err)\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbLookup() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n const local = db.collection('local')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .getTemp()\r\n const foreign = db.collection('foreign')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .getTemp()\r\n await db.collection(local, foreign)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.lookupData = res.data\r\n notify(`联表查询成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbMultiSend() : Promise<void> {\r\n const db = uniCloud.databaseForJQL()\r\n const temp1 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n const temp2 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n await db.multiSend(temp1, temp2)\r\n .then<void>(res => {\r\n uni.hideLoading()\r\n let successCount = 0\r\n for (let i = 0; i < res.dataList.length; i++) {\r\n const item = res.dataList[i]\r\n if (item.errCode == 0) {\r\n console.log(`第${i}个请求查询到${item.data!.length}条数据`)\r\n successCount++\r\n } else {\r\n console.error(`第${i}个请求查询失败，错误信息：${item.data!.length}`)\r\n }\r\n }\r\n data.multiSendSuccessCount = successCount\r\n notify(`合并查询成功，成功查询的语句条数为：${successCount}`, '提示')\r\n })\r\n .catch<void>((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n console.error(err)\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n defineExpose({\r\n data,\r\n dbAdd,\r\n dbBatchAdd,\r\n dbGet,\r\n dbGetWithCommand,\r\n dbUpdate,\r\n dbRemove,\r\n dbLookupInit,\r\n dbLookup,\r\n dbMultiSend\r\n })\r\n</script>\r\n\r\n<style>\r\n</style>\r\n\n```\n\n:::"},"onResponse":{"name":"::: sourceCode\n## onResponse(callback) @onresponse\n:::","originName":"onResponse","description":"监听响应事件","compatibility":"### onResponse 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \| 是 \| \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| type \| string \| 是 \| 响应事件类型 \|\n\| name \| string \| 是 \| 响应事件由哪个云函数触发 \|\n\| content \| any \| 是 \| 响应结果、错误内容 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onResponse)"},"offResponse":{"name":"::: sourceCode\n## offResponse(callback) @offresponse\n:::","originName":"offResponse","description":"移除响应事件监听","compatibility":"### offResponse 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \| 是 \| \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| type \| string \| 是 \| 响应事件类型 \|\n\| name \| string \| 是 \| 响应事件由哪个云函数触发 \|\n\| content \| any \| 是 \| 响应结果、错误内容 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offResponse)"},"onRefreshToken":{"name":"::: sourceCode\n## onRefreshToken(callback) @onrefreshtoken\n:::","originName":"onRefreshToken","description":"监听token刷新事件","compatibility":"### onRefreshToken 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudRefreshTokenEvent](#unicloudrefreshtokenevent-values)) => any \| 是 \| \n\n### UniCloudRefreshTokenEvent 的属性值 @unicloudrefreshtokenevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| token \| string \| 是 \| token内容 \|\n\| tokenExpired \| number \| 是 \| token过期时间 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onRefreshToken)"},"offRefreshToken":{"name":"::: sourceCode\n## offRefreshToken(callback) @offrefreshtoken\n:::","originName":"offRefreshToken","description":"移除token刷新事件监听","compatibility":"### offRefreshToken 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudRefreshTokenEvent](#unicloudrefreshtokenevent-values)) => any \| 是 \| \n\n### UniCloudRefreshTokenEvent 的属性值 @unicloudrefreshtokenevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| token \| string \| 是 \| token内容 \|\n\| tokenExpired \| number \| 是 \| token过期时间 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offRefreshToken)"},"getCurrentUserInfo":{"name":"::: sourceCode\n## getCurrentUserInfo() @getcurrentuserinfo\n:::","originName":"getCurrentUserInfo","description":"获取token内缓存的用户信息","compatibility":"### getCurrentUserInfo 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudUserInfo \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| uid \| string \| 否 \| 用户id \|\n@\| role \| Array<string> \| 是 \| 用户角色列表 \|\n@\| permission \| Array<string> \| 是 \| 用户权限列表 \|\n@\| tokenExpired \| number \| 是 \| 用户token过期时间 \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.getCurrentUserInfo)"},"connectWebSocket":{"name":"::: sourceCode\n## connectWebSocket(options) @connectwebsocket\n:::","originName":"connectWebSocket","description":"连接 WebSocket","compatibility":"### connectWebSocket 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.24 \| 4.41 \| 4.28 \| 4.24 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| UniCloudConnectWebSocketOptions \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| name \| string \| 是 \| WebSocket云函数/云对象名称 \|\n@\| query \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| 建立连接时需要传递的参数, 仅在 connection 事件中接收到 \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| SocketTask \|\n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.connectWebSocket)"}}
1	+ {"uniCloud_props":{"name":"# uniCloud","description":"","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \| 兼容性 \| 描述 \|\n\| :- \| :- \| :- \| :-: \| :- \|\n\| config \| UniCloudInitOptions \| 是 \| \| \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| provider \| string \| 是 \| 服务商，目前支持 aliyun、tencent、alipay \|\n@\| spaceName \| string \| 否 \| 服务空间名 \|\n@\| spaceId \| string \| 是 \| 服务空间id \|\n@\| clientSecret \| string \| 否 \| 阿里云clientSecret \|\n@\| endpoint \| string \| 否 \| 阿里云endpoint \|\n@\| spaceAppId \| string \| 否 \| 支付宝云spaceAppId \|\n@\| accessKey \| string \| 否 \| 支付宝云accessKey \|\n@\| secretKey \| string \| 否 \| 支付宝云secretKey \|\n@\| wsEndpoint \| string \| 否 \| 支付宝云 WebSocket Endpoint \|\n\| mixinDatacom \| any \| 是 \| \| \|\n\| SSEChannel \| [SSEChannel](#ssechannel-values) \| 是 \| <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"微信小程序\"},{\"title\":\"Android\"},{\"title\":\"iOS\"},{\"title\":\"HarmonyOS\"}],\"rows\":[[\"4.71\",\"4.71\",\"4.71\",\"4.71\",\"4.71\"]],\"status\":\"PARTIALLY_SUPPORTED\"}' /> \| 服务端通知通道 \| \n\n### SSEChannel 的方法 @ssechannel-values \n\n### open(): Promise\\<void>; @open\nopen\n开启通道，注意只有开启之后才能把SSEChannel实例传入云函数\n\n\n\n#### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<void> \|\n \n\n### toJSON(): { appId: string; pushClientId: string; seqId: string; }; @tojson\ntoJSON\n\n\n\n\n#### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [{ appId: string; pushClientId: string; seqId: string; }](#appid-values) \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| appId \| string \| 是 \|\n@\| pushClientId \| string \| 是 \|\n@\| seqId \| string \| 是 \| \n\n### close(): void; @close\nclose\n关闭通道\n\n\n\n\n### on(event: 'message', callback: (message: string) => void): void; @on\non\n监听消息接收事件\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| event \| string \| 是 \|\n\| callback \| (message: string) => void \| 是 \| \n\n\n\n### off(event: 'message', callback: (message: string) => void): void; @off\noff\n取消监听消息接收事件\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| event \| string \| 是 \|\n\| callback \| (message: string) => void \| 是 \| \n\n\n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"::: sourceCode\n## callFunction(options) @callfunction\n:::","originName":"callFunction","description":"请求云函数","compatibility":"### callFunction 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| UniCloudCallFunctionOptions \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 兼容性 \| 描述 \|\n@\| :- \| :- \| :- \| :-: \| :- \|\n@\| name \| string ([string.CloudFunctionString](/uts/data-type.md#ide-string)) \| 是 \| \| 云函数名 \|\n@\| data \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \| 云函数参数 \|\n@\| secretType \| string \| 否 \| <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"微信小程序\"},{\"title\":\"Android\"},{\"title\":\"iOS\"},{\"title\":\"HarmonyOS\"}],\"rows\":[[\"x\",\"4.41\",\"4.71\",\"4.71\",\"x\"]],\"status\":\"PARTIALLY_SUPPORTED\"}' /> \| 加密类型，指定加密请求、响应还是都加密 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| \"request\" \|\n@@\| \"response\" \|\n@@\| \"both\" \|\n@@\| \"none\" \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudCallFunctionResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| result \| [UniCloudCallFunctionResult](#unicloudcallfunctionresult-values) \| 是 \| 云函数返回结果 \|\n@\| requestId \| string \| 否 \| 云函数请求id \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudFunction.callFunction)"},"cloudFunction":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/cloud-function.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/cloud-function.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-function\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-function\n\n>示例\n```vue\n<template>\r\n <view class=\"cloud-function-page\">\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"callFunction\">请求云函数</button>\r\n <button type=\"primary\" @click=\"callFunctionWithGeneric\">请求云函数传入泛型</button>\r\n <!-- #ifdef APP-ANDROID \|\| APP-IOS -->\r\n <button type=\"primary\" @click=\"callEncryptionFunction\">请求安全网络加密云函数</button>\r\n <button type=\"primary\" @click=\"callVerifyFunction\">请求安全网络客户端校验云函数</button>\r\n <view><text class=\"tips\">安全网络相关功能需要打包自定义基座方可正常使用</text></view>\r\n <!-- #endif -->\r\n </view>\r\n </view>\r\n </view>\r\n</template>\r\n\r\n<script setup lang=\"ts\">\r\n\r\ntype PlainObject = {\r\n [key: string]: any\r\n}\r\n\r\ntype DataType = {\r\n callFunctionResult: PlainObject,\r\n callFunctionResult_Detail_functionName: string,\r\n callFunctionError: PlainObject,\r\n genericDemoShowMessage: string,\r\n isUniTest: boolean,\r\n}\r\n\r\nconst title = ref('请求云函数')\r\nconst data = reactive({\r\n callFunctionResult: {},\r\n callFunctionResult_Detail_functionName: '',\r\n callFunctionError: {},\r\n genericDemoShowMessage: '',\r\n isUniTest: false,\r\n} as DataType)\r\n\r\nfunction notify(content : string, title : string) {\r\n if (!data.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n}\r\n\r\nasync function callFunctionWithGeneric(): Promise<void> {\r\n type EchoCfResult = {\r\n showMessage : string\r\n }\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n await uniCloud.callFunction<EchoCfResult>({\r\n name: 'echo-cf',\r\n data: {\r\n num: 1,\r\n str: 'ABC'\r\n }\r\n }).then(res => {\r\n const result = res.result\r\n uni.hideLoading()\r\n data.genericDemoShowMessage = result.showMessage\r\n notify(result.showMessage, '提示')\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n }\r\n uni.hideLoading()\r\n notify(error.errMsg, '错误')\r\n })\r\n}\r\n\r\nasync function callFunction(): Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n await uniCloud.callFunction({\r\n name: 'echo-cf',\r\n data: {\r\n num: 1,\r\n str: 'ABC'\r\n }\r\n }).then(res => {\r\n const result = JSON.parse(JSON.stringify(res.result)) as PlainObject\r\n data.callFunctionResult = result\r\n const detail = result['detail'] as PlainObject\r\n data.callFunctionResult_Detail_functionName = detail['functionName'] as string\r\n console.log('callFunctionResult_Detail_functionName: ' + data.callFunctionResult_Detail_functionName)\r\n uni.hideLoading()\r\n notify(result['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n uni.hideLoading()\r\n if(err instanceof UniCloudError) {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n }\r\n notify(error.errMsg, '错误')\r\n } else {\r\n console.error(err)\r\n }\r\n })\r\n}\r\n\r\nfunction callEncryptionFunction() {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n uniCloud.callFunction({\r\n name: 'encryption',\r\n data: {},\r\n secretType: 'both'\r\n }).then(res => {\r\n uni.hideLoading()\r\n notify(JSON.stringify(res.result), '提示')\r\n }).catch((err : any \| null) => {\r\n uni.hideLoading()\r\n if(err instanceof UniCloudError) {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n }\r\n notify(error.errMsg, '错误')\r\n } else {\r\n console.error(err)\r\n }\r\n })\r\n}\r\n\r\nfunction callVerifyFunction() {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n uniCloud.callFunction({\r\n name: 'verify-client',\r\n data: {},\r\n secretType: 'both'\r\n }).then(res => {\r\n uni.hideLoading()\r\n notify(JSON.stringify(res.result), '提示')\r\n }).catch((err : any \| null) => {\r\n uni.hideLoading()\r\n if(err instanceof UniCloudError) {\r\n const error = err as UniCloudError\r\n data.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n }\r\n notify(error.errMsg, '错误')\r\n } else {\r\n console.error(err)\r\n }\r\n })\r\n}\r\n\r\nfunction jest_UniCloudError() {\r\n return new Error() instanceof UniCloudError\r\n}\r\n\r\nonLoad((options : OnLoadOptions) => {\r\n})\r\n\r\nonUnload(() => {\r\n if (data.isUniTest) {\r\n uni.hideToast()\r\n }\r\n})\r\n\r\ndefineExpose({\r\n data,\r\n callFunction,\r\n callFunctionWithGeneric,\r\n jest_UniCloudError\r\n})\r\n</script>\r\n\r\n<style>\r\n .cloud-function-page {\r\n --cloud-function-hint-color: #999999;\r\n }\r\n\r\n .tips {\r\n color: var(--cloud-function-hint-color, #999999);\r\n font-size: 12px;\r\n padding: 10px 0px;\r\n }\r\n\r\n @media (prefers-color-scheme: dark) {\r\n .cloud-function-page {\r\n --cloud-function-hint-color: #a0a0a0;\r\n }\r\n }\r\n</style>\r\n\n```\n\n:::"},"importObject":{"name":"::: sourceCode\n## importObject(objectName, options?) @importobject\n:::","originName":"importObject","description":"引用云对象","compatibility":"### importObject 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| objectName \| string ([string.CloudObjectString](/uts/data-type.md#ide-string)) \| 是 \|\n\| options \| UniCloudImportObjectOptions \| 否 \|\n@\| 名称 \| 类型 \| 必备 \| 兼容性 \| 描述 \|\n@\| :- \| :- \| :- \| :-: \| :- \|\n@\| customUI \| boolean \| 否 \| \| 是否移除自动展示的ui \|\n@\| loadingOptions \| UniCloudImportObjectLoadingOptions \| 否 \| \| loading界面配置 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| title \| string \| 否 \| 加载框标题 \|\n@@\| mask \| boolean \| 否 \| 加载框是否显示mask \|\n@\| errorOptions \| UniCloudImportObjectErrorOptions \| 否 \| \| 错误提示配置 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| type \| string \| 否 \| 错误提示类型，可以是modal或者toast \|\n@@\| retry \| boolean \| 否 \| 是否显示重试按钮 \|\n@\| secretMethods \| Record\\<K, T> \| 否 \| <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"微信小程序\"},{\"title\":\"Android\"},{\"title\":\"iOS\"},{\"title\":\"HarmonyOS\"}],\"rows\":[[\"x\",\"4.41\",\"4.71\",\"4.71\",\"x\"]],\"status\":\"PARTIALLY_SUPPORTED\"}' /> \| 指定方法的加密类型 \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudCloudObjectCaller](#unicloudcloudobjectcaller-values) \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| _obj \| [InternalUniCloudCloudObject](#internalunicloudcloudobject-values) \| 是 \|\n##### InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values \n\n##### callMethod\\<T = UTSJSONObject>(methodName: string, args: Array\\<any>): Promise\\<T>; @callmethod\ncallMethod\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| methodName \| string \| 是 \|\n\| args \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<T> \|\n \n\n#### UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values \n\n#### _getArgs: protected _getArgs(...args: Array\\<any>): Array\\<any \\\| null>; @_getargs\n_getArgs\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<any> \| 否 \| \n\n\n##### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Array<any> \|\n \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudObject.importObject)"},"cloudObject":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/cloud-object.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/cloud-object.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-object\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-object\n\n>示例\n```vue\n<template>\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodo\">添加Todo</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodoWithGeneric\">\r\n 添加Todo传入泛型\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"randomFail\">随机触发失败重试</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"fail\">云对象失败调用</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"failWithNumberErrCode\">\r\n 云对象数字错误码\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"success\">云对象成功调用</button>\r\n </view>\r\n </view>\r\n </view>\r\n</template>\r\n\r\n<script setup lang=\"ts\">\r\n\r\n\r\n type DataType = {\r\n todoTitle: string,\r\n todoContent: string,\r\n returnTodoTitle: string,\r\n returnTodoContent: string,\r\n genericDemoReturnTodoTitle: string,\r\n genericDemoReturnTodoContent: string,\r\n failErrCode: string,\r\n failErrSubject: string,\r\n failErrDetailTips: string,\r\n failNumberErrCode: number,\r\n successErrCode: number,\r\n isUniTest: boolean,\r\n }\r\n\r\n // Data\r\n const title = ref('请求云对象')\r\n const data = reactive({\r\n todoTitle: '学习编程',\r\n todoContent: '熟悉uts语法',\r\n returnTodoTitle: '',\r\n returnTodoContent: '',\r\n genericDemoReturnTodoTitle: '',\r\n genericDemoReturnTodoContent: '',\r\n failErrCode: '',\r\n failErrSubject: '',\r\n failErrDetailTips: '',\r\n failNumberErrCode: 0,\r\n successErrCode: -1,\r\n isUniTest: false,\r\n } as DataType)\r\n\r\n // Functions\r\n function notify(content : string, title : string) {\r\n if (!data.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n }\r\n\r\n async function addTodo() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n const title = data.todoTitle\r\n const content = data.todoContent\r\n await todo.add<UTSJSONObject>(title, content).then((res : UTSJSONObject) => {\r\n data.returnTodoTitle = res['title'] as string\r\n data.returnTodoContent = res['content'] as string\r\n notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n\r\n async function addTodoWithGeneric() : Promise<void> {\r\n type AddTodoResult = {\r\n title : string,\r\n content : string,\r\n showMessage : string\r\n }\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n const title = data.todoTitle\r\n const content = data.todoContent\r\n await todo.add<AddTodoResult>(title, content).then((res : AddTodoResult) => {\r\n data.genericDemoReturnTodoTitle = res.title\r\n data.genericDemoReturnTodoContent = res.content\r\n notify(res.showMessage, '提示')\r\n }).catch((err : any \| null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n\r\n async function randomFail() : Promise<void> {\r\n const todoObj = uniCloud.importObject('todo', {\r\n errorOptions: {\r\n retry: true\r\n }\r\n })\r\n await todoObj.randomFail().then((res : UTSJSONObject) => {\r\n notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n console.log(error)\r\n })\r\n }\r\n\r\n async function fail() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n await todo.fail().then((res : UTSJSONObject) => {\r\n notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n data.failErrCode = error.errCode as string\r\n data.failErrSubject = error.errSubject as string\r\n const detail = error.detail\r\n if (detail != null && detail['tips'] != null) {\r\n data.failErrDetailTips = detail['tips'] as string\r\n }\r\n console.log(error)\r\n })\r\n }\r\n\r\n async function failWithNumberErrCode() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n await todo.failWithNumberErrCode().then((res : UTSJSONObject) => {\r\n notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n data.failNumberErrCode = error.errCode as number\r\n console.log(error)\r\n })\r\n }\r\n\r\n async function success() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: data.isUniTest\r\n })\r\n await todo.success().then((res : UTSJSONObject) => {\r\n data.successErrCode = res['errCode'] as number\r\n notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any \| null) => {\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n\r\n defineExpose({\r\n data,\r\n addTodo,\r\n addTodoWithGeneric,\r\n fail,\r\n failWithNumberErrCode,\r\n success\r\n })\r\n</script>\r\n\r\n<style></style>\r\n\n```\n\n:::"},"uploadFile":{"name":"::: sourceCode\n## uploadFile(options) @uploadfile\n:::","originName":"uploadFile","description":"上传文件到云存储","compatibility":"### uploadFile 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| filePath \| string \| 是 \| 文件路径 \|\n@\| cloudPath \| string \| 是 \| 云端路径 \|\n@\| cloudPathAsRealPath \| boolean \| 否 \| 是否以云端路径是否为真实路径保存上传的文件 \| \n\n### UniCloudUploadFileOptions 的方法 @uniclouduploadfileoptions-values \n\n### onUploadProgress: (options: UniCloudUploadProgress) => any @onuploadprogress\nonUploadProgress\n上传进度回调\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| options \| UniCloudUploadProgress \| 是 \| 上传进度回调参数 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| loaded \| number \| 是 \| 已上传大小 \|\n@\| total \| number \| 是 \| 总大小 \| \n\n\n#### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| any \|\n \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudUploadFileResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| filePath \| string \| 是 \| 文件路径 \|\n@\| fileID \| string \| 是 \| 文件id \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.uploadFile)"},"getTempFileURL":{"name":"::: sourceCode\n## getTempFileURL(options) @gettempfileurl\n:::","originName":"getTempFileURL","description":"获取文件临时URL","compatibility":"### getTempFileURL 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| UniCloudGetTempFileURLOptions \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| fileList \| Array<string> \| 是 \| 文件列表 \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudGetTempFileURLResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| fileList \| Array<UniCloudGetTempFileURLResultItem> \| 是 \| 文件列表 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| fileID \| string \| 是 \| 文件id \|\n@@\| tempFileURL \| string \| 是 \| 文件临时url \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.chooseAndUploadFile)"},"chooseAndUploadFile":{"name":"::: sourceCode\n## chooseAndUploadFile(options) @chooseanduploadfile\n:::","originName":"chooseAndUploadFile","description":"选择并上传文件","compatibility":"### chooseAndUploadFile 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) \| 是 \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| sourceType \| Array<string> \| 否 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| \"album\" \|\n@@\| \"camera\" \|\n@\| count \| number \| 否 \|\n@\| sizeType \| Array<string> \| 否 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| \"original\" \|\n@@\| \"compressed\" \|\n@\| extension \| Array<string> \| 否 \|\n@\| compressed \| boolean \| 否 \|\n@\| maxDuration \| number \| 否 \|\n@\| camera \| string \| 否 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| \"front\" \|\n@@\| \"back\" \|\n@\| crop \| ChooseImageCropOptions \| 否 \|\n@\| type \| string \| 是 \|\n@@\| 合法值 \|\n@@\| :- \|\n@@\| \"image\" \|\n@@\| \"video\" \|\n@@\| \"all\" \| \n\n### UniCloudChooseAndUploadFileOptions 的方法 @unicloudchooseanduploadfileoptions-values \n\n### onChooseFile: (arg: UniCloudChooseAndUploadFileResult) => void \\\| null @onchoosefile\nonChooseFile\n\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| UniCloudChooseAndUploadFileResult \| 是 \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| tempFiles \| Array<UniCloudChooseAndUploadFileItem> \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \|\n@@\| :- \| :- \| :- \|\n@@\| name \| string \| 是 \|\n@@\| path \| string \| 是 \|\n@@\| cloudPath \| string \| 是 \|\n@@\| cloudPathAsRealPath \| boolean \| 否 \|\n@@\| url \| string \| 否 \|\n@@\| errMsg \| string \| 否 \|\n@\| tempFilePaths \| Array<string> \| 是 \| \n\n\n\n### onUploadProgress: (arg: UniCloudChooseAndUploadFileProgressEvent) => void \\\| null @onuploadprogress\nonUploadProgress\n\n\n#### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| UniCloudChooseAndUploadFileProgressEvent \| 是 \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| index \| number \| 是 \|\n@\| loaded \| number \| 是 \|\n@\| total \| number \| 是 \|\n@\| tempFilePath \| string \| 是 \|\n@\| tempFile \| UniCloudChooseAndUploadFileItem \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \|\n@@\| :- \| :- \| :- \|\n@@\| name \| string \| 是 \|\n@@\| path \| string \| 是 \|\n@@\| cloudPath \| string \| 是 \|\n@@\| cloudPathAsRealPath \| boolean \| 否 \|\n@@\| url \| string \| 否 \|\n@@\| errMsg \| string \| 否 \| \n\n\n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudChooseAndUploadFileResult> \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| tempFiles \| Array<UniCloudChooseAndUploadFileItem> \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \|\n@@\| :- \| :- \| :- \|\n@@\| name \| string \| 是 \|\n@@\| path \| string \| 是 \|\n@@\| cloudPath \| string \| 是 \|\n@@\| cloudPathAsRealPath \| boolean \| 否 \|\n@@\| url \| string \| 否 \|\n@@\| errMsg \| string \| 否 \|\n@\| tempFilePaths \| Array<string> \| 是 \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.getTempFileURL)"},"cloudStorage":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/cloud-storage.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/cloud-storage.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-storage\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-storage\n\n>示例\n```vue\n<template>\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"uploadFile\">选择文件上传</button>\r\n <button type=\"primary\" @click=\"chooseAndUploadFile\">一个接口选择文件并上传</button>\r\n </view>\r\n </view>\r\n </view>\r\n</template>\r\n\r\n<script setup lang=\"ts\">\r\n\r\n\r\n // Data\r\n const title = ref('云存储')\r\n\r\n // Functions\r\n function uploadFile() {\r\n uni.chooseImage({\r\n count: 1,\r\n success(res) : void {\r\n uni.showLoading({\r\n title: '上传中...'\r\n })\r\n const tempFilePath = res.tempFilePaths[0]\r\n uniCloud.uploadFile({\r\n filePath: tempFilePath,\r\n cloudPath: 'test.jpg'\r\n })\r\n .then(function (res) {\r\n uni.hideLoading()\r\n uni.showModal({\r\n content: '上传成功',\r\n showCancel: false\r\n });\r\n })\r\n .catch(function (err : any \| null) {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n uni.showModal({\r\n content: '上传失败，' + error.errMsg,\r\n showCancel: false\r\n });\r\n })\r\n // .finally((_: number) : void => {\r\n // uni.hideLoading()\r\n // })\r\n },\r\n fail(err) : void {\r\n console.error('chooseImage fail: ', err)\r\n }\r\n })\r\n }\r\n\r\n function chooseAndUploadFile() {\r\n uniCloud.chooseAndUploadFile({\r\n type: 'image'\r\n }).then(function (res) {\r\n uni.hideLoading()\r\n uni.showModal({\r\n content: '上传成功',\r\n showCancel: false\r\n });\r\n })\r\n .catch(function (err : any \| null) {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n uni.showModal({\r\n content: '上传失败，' + error.errMsg,\r\n showCancel: false\r\n });\r\n })\r\n }\r\n</script>\r\n\r\n<style>\r\n</style>\r\n\n```\n\n:::"},"databaseForJQL":{"name":"::: sourceCode\n## databaseForJQL() @databaseforjql\n:::","originName":"databaseForJQL","description":"获取数据库操作实例","compatibility":"### databaseForJQL 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.91，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [Database](#database-values) \|\n@\| 名称 \| 类型 \| 必备 \|\n@\| :- \| :- \| :- \|\n@\| command \| [UniCloudDBCommand](#uniclouddbcommand-values) \| 是 \|\n@\| Geo \| UniCloudDBGeo \| 是 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| Point \| GeoPoint \| 是 \| 地理位置点 \|\n@@\| LineString \| GeoLineString \| 是 \| 地理路径，是由两个或者更多的 Point 组成的线段 \|\n@@\| Polygon \| GeoPolygon \| 是 \| 地理上的一个多边形（有洞或无洞均可），它是由一个或多个闭环 LineString 组成的几何图形 \|\n@@\| MultiPoint \| GeoMultiPoint \| 是 \| 多个地理位置点 Point 的集合 \|\n@@\| MultiLineString \| GeoMultiLineString \| 是 \| 多个地理路径 LineString 的集合 \|\n@@\| MultiPolygon \| GeoMultiPolygon \| 是 \| 多个地理多边形 Polygon 的集合 \|\n##### UniCloudDBCommand 的方法 @uniclouddbcommand-values \n\n##### and(args: Array\\<UTSJSONObject>): UTSJSONObject; @and\nand\n查询操作符，用于表示逻辑 \"与\" 的关系，表示需同时满足多个查询筛选条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### or(args: Array\\<UTSJSONObject>): UTSJSONObject; @or\nor\n查询操作符，用于表示逻辑 \"或\" 的关系，表示需同时满足多个查询筛选条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### not(arg: UTSJSONObject): UTSJSONObject; @not\nnot\n查询操作符，用于表示逻辑 \"非\" 的关系，表示需不满足指定的条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### nor(args: Array\\<UTSJSONObject>): UTSJSONObject; @nor\nnor\n查询操作符，用于表示逻辑 \"都不\" 的关系，表示需不满足指定的所有条件\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### eq(arg: any): UTSJSONObject; @eq\neq\n查询筛选条件，表示字段等于某个值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### neq(arg: any): UTSJSONObject; @neq\nneq\n查询筛选条件，表示字段不等于某个值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### lt(arg: any): UTSJSONObject; @lt\nlt\n查询筛选操作符，表示需小于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### lte(arg: any): UTSJSONObject; @lte\nlte\n查询筛选操作符，表示需小于或等于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### gt(arg: any): UTSJSONObject; @gt\ngt\n查询筛选操作符，表示需大于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### gte(arg: any): UTSJSONObject; @gte\ngte\n查询筛选操作符，表示需大于或等于指定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### in(arr: Array\\<any>): UTSJSONObject; @in\nin\n查询筛选操作符，表示要求值在给定的数组内\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arr \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### nin(arr: Array\\<any>): UTSJSONObject; @nin\nnin\n查询筛选操作符，表示要求值不在给定的数组内\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arr \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### exists(arg: boolean): UTSJSONObject; @exists\nexists\n判断字段是否存在\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| boolean \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### mod(divisor: number, remainder: number): UTSJSONObject; @mod\nmod\n查询筛选操作符，给定除数 divisor 和余数 remainder\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| divisor \| number \| 是 \| 除数 \|\n\| remainder \| number \| 是 \| 余数 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### all(arr: Array\\<any>): UTSJSONObject; @all\nall\n数组查询操作符。用于数组字段的查询筛选条件，要求数组字段中包含给定数组的所有元素\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arr \| Array<any> \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### elemMatch(arg: UTSJSONObject): UTSJSONObject; @elemmatch\nelemMatch\n用于数组字段的查询筛选条件，要求数组中包含至少一个满足 elemMatch 给定的所有条件的元素\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### size(arg: number): UTSJSONObject; @size\nsize\n更新操作符，用于数组字段的查询筛选条件，要求数组长度为给定值\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### geoNear(arg: UTSJSONObject): UTSJSONObject; @geonear\ngeoNear\n按从近到远的顺序，找出字段值在给定点的附近的记录\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### geoWithin(arg: UTSJSONObject): UTSJSONObject; @geowithin\ngeoWithin\n找出字段值在指定区域内的记录，无排序。指定的区域必须是多边形（Polygon）或多边形集合（MultiPolygon）\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n##### geoIntersects(arg: UTSJSONObject): UTSJSONObject; @geointersects\ngeoIntersects\n找出给定的地理位置图形相交的记录\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n#### Database 的方法 @database-values \n\n#### collection(...args: Array\\<any>): Collection; @collection\ncollection\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<any> \| 否 \| \n\n\n##### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [Collection](#collection-values) \|\n\n###### Collection 的方法 @collection-values \n\n###### where(condition: any): UniCloudDBFilter; @where\nwhere\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| condition \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n\n###### UniCloudDBFilter 的方法 @uniclouddbfilter-values \n\n###### get(arg?: UTSJSONObject): Promise\\<UniCloudDBGetResult>; @get\nget\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBGetResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| 添加的记录的id列表 \|\n@\| count \| number \| 否 \| 匹配到的数据总量 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\ncount\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBCountResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| total \| number \| 是 \| 添加的记录的id列表 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### update(data: UTSJSONObject): Promise\\<UniCloudDBUpdateResult>; @update\nupdate\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| data \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBUpdateResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| updated \| number \| 是 \| 更新成功的记录数 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### remove(): Promise\\<UniCloudDBRemoveResult>; @remove\nremove\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBRemoveResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| deleted \| number \| 是 \| 删除成功的记录数 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### getTemp(): UTSJSONObject; @gettemp\ngetTemp\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n###### where(condition: any): UniCloudDBFilter; @where\nwhere\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| condition \| any \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBFilter \|\n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\ndoc\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| docId \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBFilter \|\n \n\n###### field(filed: string): UniCloudDBQuery; @field\nfield\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| filed \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n\n###### UniCloudDBQuery 的方法 @uniclouddbquery-values \n\n###### get(arg?: UTSJSONObject): Promise\\<UniCloudDBGetResult>; @get\nget\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBGetResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| 添加的记录的id列表 \|\n@\| count \| number \| 否 \| 匹配到的数据总量 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\ncount\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBCountResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| total \| number \| 是 \| 添加的记录的id列表 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### getTemp(): UTSJSONObject; @gettemp\ngetTemp\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n###### field(filed: string): UniCloudDBQuery; @field\nfield\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| filed \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\nskip\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\nlimit\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\norderBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| order \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\ngroupBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\ngroupField\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\ndistinct\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\ngeoNear\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudDBQuery \|\n \n \n\n###### skip(num: number): UniCloudDBQuery; @skip\nskip\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\nlimit\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\norderBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| order \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\ngroupBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\ngroupField\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\ndistinct\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| field \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\ngeoNear\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\ndoc\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| docId \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n \n\n###### aggregate(): UniCloudDBFilter; @aggregate\naggregate\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n \n\n###### foreignKey(foreignKey: string): UniCloudDBFilter; @foreignkey\nforeignKey\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| foreignKey \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBFilter](#uniclouddbfilter-values) \|\n \n\n###### add(data: UTSJSONObject): Promise\\<UniCloudDBAddResult>; @add\nadd\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| data \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBAddResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| id \| string \| 是 \| 添加的记录的id \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### get(arg?: UTSJSONObject): Promise\\<UniCloudDBGetResult>; @get\nget\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| arg \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBGetResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 是 \| 添加的记录的id列表 \|\n@\| count \| number \| 否 \| 匹配到的数据总量 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\ncount\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBCountResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| total \| number \| 是 \| 添加的记录的id列表 \|\n@\| requestId \| string \| 否 \| 请求id \| \n\n###### getTemp(): UTSJSONObject; @gettemp\ngetTemp\n\n\n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \|\n \n\n###### field(filed: string): UniCloudDBQuery; @field\nfield\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| filed \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\nskip\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\nlimit\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| num \| number \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\norderBy\n\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| order \| string \| 是 \| \n\n\n###### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| [UniCloudDBQuery](#uniclouddbquery-values) \|\n \n \n\n#### multiSend(...args: Array\\<UTSJSONObject>): Promise\\<UniCloudDBMultiSendResult>; @multisend\nmultiSend\n合并查询请求\n##### multiSend 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 4.16 \| 4.11 \| 4.61 \|\n\n##### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| args \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 否 \| \n\n\n##### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| Promise\\<UniCloudDBMultiSendResult> \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| dataList \| Array<UniCloudDBMultiSendResultItem> \| 是 \| 数据列表 \|\n@@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@@\| :- \| :- \| :- \| :- \|\n@@\| errCode \| any \| 是 \| 错误码，可能为字符串或数字，数字0表示成功 \|\n@@\| errMsg \| string \| 是 \| 错误信息 \|\n@@\| data \| Array<[UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md)> \| 否 \| 数据 \|\n@\| requestId \| string \| 否 \| 请求id \| \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.database.databaseForJQL)"},"database":{"example":"## 示例\n\n示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/unicloud/unicloud/database.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/unicloud/unicloud/database.uvue) \n::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/database\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/database\n\n>示例\n```vue\n<template>\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"dbAdd\">新增单条数据</button>\r\n <button type=\"primary\" @click=\"dbBatchAdd\">新增多条数据</button>\r\n <button type=\"primary\" @click=\"dbUpdate\">更新数据</button>\r\n <button type=\"primary\" @click=\"dbGet\">where传字符串获取数据</button>\r\n <button type=\"primary\" @click=\"dbGetWithCommand\">where传对象获取数据</button>\r\n <button type=\"primary\" @click=\"dbRemove\">删除数据</button>\r\n <button type=\"primary\" @click=\"dbLookupInit\">初始化联表查询数据</button>\r\n <button type=\"primary\" @click=\"dbLookup\">联表查询</button>\r\n <button type=\"primary\" @click=\"dbMultiSend\">合并查询查询</button>\r\n </view>\r\n </view>\r\n </view>\r\n</template>\r\n\r\n<script setup lang=\"ts\">\r\n\r\n\r\n type DataType = {\r\n addId: string,\r\n batchAddIds: Array<string>,\r\n batchAddinserted: number,\r\n updateUpdated: number,\r\n getData: Array<UTSJSONObject>,\r\n getWithCommandData: Array<UTSJSONObject>,\r\n removeDeleted: number,\r\n lookupData: Array<UTSJSONObject>,\r\n multiSendSuccessCount: number,\r\n isUniTest: boolean,\r\n }\r\n\r\n // Data\r\n const title = ref('ClientDB')\r\n const data = reactive({\r\n addId: '',\r\n batchAddIds: [] as Array<string>,\r\n batchAddinserted: 0,\r\n updateUpdated: 0,\r\n getData: [] as Array<UTSJSONObject>,\r\n getWithCommandData: [] as Array<UTSJSONObject>,\r\n removeDeleted: 0,\r\n lookupData: [] as Array<UTSJSONObject>,\r\n multiSendSuccessCount: 0,\r\n isUniTest: false,\r\n } as DataType)\r\n\r\n // Computed\r\n const dataTag = computed<string>(() => {\r\n return data.isUniTest ? 'default-tag' + Date.now() : 'default-tag'\r\n })\r\n\r\n // Functions\r\n function notify(content : string, title : string) {\r\n if (!data.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n }\r\n\r\n async function dbAdd() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .add({\r\n num: 1,\r\n tag: dataTag.value,\r\n date: new Date()\r\n })\r\n .then(res => {\r\n uni.hideLoading()\r\n data.addId = res.id\r\n notify(`新增成功，id: ${res.id}`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbBatchAdd() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .add([{\r\n num: 2,\r\n tag: dataTag.value,\r\n }, {\r\n num: 3,\r\n tag: dataTag.value,\r\n }])\r\n .then((res) => {\r\n uni.hideLoading()\r\n data.batchAddIds = res.ids\r\n data.batchAddinserted = res.inserted\r\n notify(`新增成功条数${res.inserted}, id列表: ${res.ids.join(',')}`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbGet() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${dataTag.value}\"`\r\n )\r\n .field('num, tag')\r\n .orderBy('num desc')\r\n .skip(1)\r\n .limit(2)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.getData = res.data\r\n notify(`获取成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbGetWithCommand() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where({\r\n num: db.command.gt(1),\r\n tag: dataTag.value\r\n })\r\n .field('num, tag')\r\n .orderBy('num desc')\r\n .skip(1)\r\n .limit(2)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.getWithCommandData = res.data\r\n notify(`获取成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbUpdate() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${dataTag.value}\"`\r\n )\r\n .update({\r\n num: 4\r\n })\r\n .then(res => {\r\n uni.hideLoading()\r\n data.updateUpdated = res.updated\r\n notify(`更新成功，更新了${res.updated}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbRemove() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${dataTag.value}\"`\r\n )\r\n .remove()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.removeDeleted = res.deleted\r\n notify(`删除成功，删掉了${res.deleted}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbLookupInit() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('local')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .remove()\r\n .then(() : Promise<UniCloudDBRemoveResult> => {\r\n return db.collection('foreign')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .remove()\r\n })\r\n .then(() : Promise<UniCloudDBBatchAddResult> => {\r\n return db.collection('local')\r\n .add([{\r\n id: \"local_1\",\r\n name: \"local_1_name\",\r\n tag: dataTag.value,\r\n foreign_id: \"foreign_1\"\r\n }, {\r\n id: \"local_2\",\r\n name: \"local_2_name\",\r\n tag: dataTag.value,\r\n foreign_id: \"foreign_2\"\r\n }])\r\n })\r\n .then(() : Promise<UniCloudDBBatchAddResult> => {\r\n return db.collection('foreign')\r\n .add([{\r\n id: \"foreign_1\",\r\n name: \"foreign_1_name\",\r\n tag: dataTag.value\r\n }, {\r\n id: \"foreign_2\",\r\n name: \"foreign_2_name\",\r\n tag: dataTag.value\r\n }])\r\n })\r\n .then((_) : void => {\r\n uni.hideLoading()\r\n notify('数据初始化成功', '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n console.error(err)\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbLookup() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n const local = db.collection('local')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .getTemp()\r\n const foreign = db.collection('foreign')\r\n .where(`tag == \"${dataTag.value}\"`)\r\n .getTemp()\r\n await db.collection(local, foreign)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n data.lookupData = res.data\r\n notify(`联表查询成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n async function dbMultiSend() : Promise<void> {\r\n const db = uniCloud.databaseForJQL()\r\n const temp1 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n const temp2 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n await db.multiSend(temp1, temp2)\r\n .then<void>(res => {\r\n uni.hideLoading()\r\n let successCount = 0\r\n for (let i = 0; i < res.dataList.length; i++) {\r\n const item = res.dataList[i]\r\n if (item.errCode == 0) {\r\n console.log(`第${i}个请求查询到${item.data!.length}条数据`)\r\n successCount++\r\n } else {\r\n console.error(`第${i}个请求查询失败，错误信息：${item.data!.length}`)\r\n }\r\n }\r\n data.multiSendSuccessCount = successCount\r\n notify(`合并查询成功，成功查询的语句条数为：${successCount}`, '提示')\r\n })\r\n .catch<void>((err : any \| null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n console.error(err)\r\n notify(error.errMsg, '错误')\r\n })\r\n }\r\n\r\n defineExpose({\r\n data,\r\n dbAdd,\r\n dbBatchAdd,\r\n dbGet,\r\n dbGetWithCommand,\r\n dbUpdate,\r\n dbRemove,\r\n dbLookupInit,\r\n dbLookup,\r\n dbMultiSend\r\n })\r\n</script>\r\n\r\n<style>\r\n</style>\r\n\n```\n\n:::"},"onResponse":{"name":"::: sourceCode\n## onResponse(callback) @onresponse\n:::","originName":"onResponse","description":"监听响应事件","compatibility":"### onResponse 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \| 是 \| \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| type \| string \| 是 \| 响应事件类型 \|\n\| name \| string \| 是 \| 响应事件由哪个云函数触发 \|\n\| content \| any \| 是 \| 响应结果、错误内容 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onResponse)"},"offResponse":{"name":"::: sourceCode\n## offResponse(callback) @offresponse\n:::","originName":"offResponse","description":"移除响应事件监听","compatibility":"### offResponse 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any \| 是 \| \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| type \| string \| 是 \| 响应事件类型 \|\n\| name \| string \| 是 \| 响应事件由哪个云函数触发 \|\n\| content \| any \| 是 \| 响应结果、错误内容 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offResponse)"},"onRefreshToken":{"name":"::: sourceCode\n## onRefreshToken(callback) @onrefreshtoken\n:::","originName":"onRefreshToken","description":"监听token刷新事件","compatibility":"### onRefreshToken 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudRefreshTokenEvent](#unicloudrefreshtokenevent-values)) => any \| 是 \| \n\n### UniCloudRefreshTokenEvent 的属性值 @unicloudrefreshtokenevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| token \| string \| 是 \| token内容 \|\n\| tokenExpired \| number \| 是 \| token过期时间 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onRefreshToken)"},"offRefreshToken":{"name":"::: sourceCode\n## offRefreshToken(callback) @offrefreshtoken\n:::","originName":"offRefreshToken","description":"移除token刷新事件监听","compatibility":"### offRefreshToken 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| callback \| (arg: [UniCloudRefreshTokenEvent](#unicloudrefreshtokenevent-values)) => any \| 是 \| \n\n### UniCloudRefreshTokenEvent 的属性值 @unicloudrefreshtokenevent-values \n\n\| 名称 \| 类型 \| 必备 \| 描述 \|\n\| :- \| :- \| :- \| :- \|\n\| token \| string \| 是 \| token内容 \|\n\| tokenExpired \| number \| 是 \| token过期时间 \|\n","fileFormats":"","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offRefreshToken)"},"getCurrentUserInfo":{"name":"::: sourceCode\n## getCurrentUserInfo() @getcurrentuserinfo\n:::","originName":"getCurrentUserInfo","description":"获取token内缓存的用户信息","compatibility":"### getCurrentUserInfo 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.0 \| 4.41 \| 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 \| 4.11 \| 4.61 \|\n","param":"","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| UniCloudUserInfo \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| uid \| string \| 否 \| 用户id \|\n@\| role \| Array<string> \| 是 \| 用户角色列表 \|\n@\| permission \| Array<string> \| 是 \| 用户权限列表 \|\n@\| tokenExpired \| number \| 是 \| 用户token过期时间 \| \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.getCurrentUserInfo)"},"connectWebSocket":{"name":"::: sourceCode\n## connectWebSocket(options) @connectwebsocket\n:::","originName":"connectWebSocket","description":"连接 WebSocket","compatibility":"### connectWebSocket 兼容性 <Help /> \n\| Web \| 微信小程序 \| Android \| iOS \| HarmonyOS \|\n\| :- \| :- \| :- \| :- \| :- \|\n\| 4.24 \| 4.41 \| 4.28 \| 4.24 \| 4.61 \|\n","param":"### 参数 \n\n\| 名称 \| 类型 \| 必填 \|\n\| :- \| :- \| :- \|\n\| options \| UniCloudConnectWebSocketOptions \| 是 \|\n@\| 名称 \| 类型 \| 必备 \| 描述 \|\n@\| :- \| :- \| :- \| :- \|\n@\| name \| string \| 是 \| WebSocket云函数/云对象名称 \|\n@\| query \| [UTSJSONObject](/uts/buildin-object-api/utsjsonobject.md) \| 否 \| 建立连接时需要传递的参数, 仅在 connection 事件中接收到 \| \n","fileFormats":"","returnValue":"### 返回值 \n\n\| 类型 \|\n\| :- \|\n\| SocketTask \|\n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.connectWebSocket)"}}