diff --git a/docs/.vuepress/utils/utsUnicloudApiJson.json b/docs/.vuepress/utils/utsUnicloudApiJson.json index f95b2adc580362abdd13374f0e5e6c322d9a5276..ce32f11828fce6ac6761b51569e65ca3b79c80c2 100644 --- a/docs/.vuepress/utils/utsUnicloudApiJson.json +++ b/docs/.vuepress/utils/utsUnicloudApiJson.json @@ -1 +1 @@ -{"uniCloud_props":{"name":"# uniCloud","description":"","param":"## 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| config | [UniCloudInitOptions](#unicloudinitoptions) | 是 | - | - |\n### UniCloudInitOptions 属性值 @unicloudinitoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| provider | string | 是 | - | 服务商，目前支持 aliyun、tencent |\n| spaceName | string | 否 | - | 服务空间名 |\n| spaceId | string | 是 | - | 服务空间id |\n| clientSecret | string | 否 | - | 阿里云clientSecret |\n| endpoint | string | 否 | - | 阿里云endpoint |\n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"## callFunction(options) @callfunction","description":"请求云函数","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudCallFunctionOptions](#unicloudcallfunctionoptions) | 是 | - | - |\n#### UniCloudCallFunctionOptions 属性值 @unicloudcallfunctionoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | 云函数名 |\n| data | any | 否 | - | 云函数参数 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudCallFunctionResult](#unicloudcallfunctionresult)> | \n\n#### UniCloudCallFunctionResult 属性值 @unicloudcallfunctionresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| result | any | 是 | - | 云函数参数 |\n| requestId | string | 否 | - | 云函数请求id |\n","compatibility":"### callFunction 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"uploadFile":{"name":"## uploadFile(options) @uploadfile","description":"上传文件到云存储","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions) | 是 | - | - |\n#### UniCloudUploadFileOptions 属性值 @uniclouduploadfileoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | 文件路径 |\n| cloudPath | string | 是 | - | 云端路径 |\n| cloudPathAsRealPath | boolean | 否 | - | 是否以云端路径是否为真实路径保存上传的文件 |\n| onUploadProgress | (options: [UniCloudUploadProgress](#uniclouduploadprogress)) => any | 否 | - | 上传进度回调 |\n\n##### UniCloudUploadProgress 属性值 @uniclouduploadprogress \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| loaded | number | 是 | - | 已上传大小 |\n| total | number | 是 | - | 总大小 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudUploadFileResult](#uniclouduploadfileresult)> | \n\n#### UniCloudUploadFileResult 属性值 @uniclouduploadfileresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | 文件路径 |\n| fileID | string | 是 | - | 文件id |\n","compatibility":"### uploadFile 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"getTempFileURL":{"name":"## getTempFileURL(options) @gettempfileurl","description":"获取文件临时URL","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudGetTempFileURLOptions](#unicloudgettempfileurloptions) | 是 | - | - |\n#### UniCloudGetTempFileURLOptions 属性值 @unicloudgettempfileurloptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fileList | Array\\ | 是 | - | 文件列表 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudGetTempFileURLResult](#unicloudgettempfileurlresult)> | \n\n#### UniCloudGetTempFileURLResult 属性值 @unicloudgettempfileurlresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fileList | Array\\<[UniCloudGetTempFileURLResultItem](#unicloudgettempfileurlresultitem)\\> | 是 | - | 文件列表 |\n\n##### UniCloudGetTempFileURLResultItem 属性值 @unicloudgettempfileurlresultitem \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fileID | string | 是 | - | 文件id |\n| tempFileURL | string | 是 | - | 文件临时url |\n","compatibility":"### getTempFileURL 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"importObject":{"name":"## importObject(objectName, options?) @importobject","description":"引用云对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| objectName | string | 是 | - | - |\n| options | [UniCloudImportObjectOptions](#unicloudimportobjectoptions) | 否 | - | - |\n#### UniCloudImportObjectOptions 属性值 @unicloudimportobjectoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| customUI | boolean | 否 | - | 是否移除自动展示的ui |\n| loadingOptions | [UniCloudImportObjectLoadingOptions](#unicloudimportobjectloadingoptions) | 否 | - | loading界面配置 |\n| errorOptions | [UniCloudImportObjectErrorOptions](#unicloudimportobjecterroroptions) | 否 | - | 错误提示配置 |\n\n##### UniCloudImportObjectLoadingOptions 属性值 @unicloudimportobjectloadingoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 否 | - | 加载框标题 |\n| mask | boolean | 否 | - | 是否移除自动展示的ui |\n\n##### UniCloudImportObjectErrorOptions 属性值 @unicloudimportobjecterroroptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 否 | - | 加载框标题 |\n| retry | boolean | 否 | - | 是否移除自动展示的ui |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"### importObject 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"onResponse":{"name":"## onResponse(callback) @onresponse","description":"监听响应事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onResponse 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"offResponse":{"name":"## offResponse(callback) @offresponse","description":"移除响应事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offResponse 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"onRefreshToken":{"name":"## onRefreshToken(callback) @onrefreshtoken","description":"监听token刷新事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onRefreshToken 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"offRefreshToken":{"name":"## offRefreshToken(callback) @offrefreshtoken","description":"移除token刷新事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offRefreshToken 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"databaseForJQL":{"name":"## databaseForJQL() @databaseforjql","description":"获取数据库操作实例","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [Database](#database) | \n\n#### Database 属性值 @database \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| ctors | Constructor | 是 | - | - |\n| _client | any | 是 | - | - |\n| collection | (args?: Array\\) => [Collection](#collection) | 是 | - | - |\n| command | any | 是 | - | - |\n| Geo | any | 是 | - | - |\n","compatibility":"### databaseForJQL 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"getCurrentUserInfo":{"name":"## getCurrentUserInfo() @getcurrentuserinfo","description":"获取token内缓存的用户信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudUserInfo](#uniclouduserinfo) | \n\n#### UniCloudUserInfo 属性值 @uniclouduserinfo \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| uid | string | 否 | - | UserInfo = { / |\n| role | Array\\ | 是 | - | ing \\| null; / |\n| permission | Array\\ | 是 | - | ay\\; / |\n| tokenExpired | number | 是 | - | ay\\; /** |\n","compatibility":"### getCurrentUserInfo 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""},"chooseAndUploadFile":{"name":"## chooseAndUploadFile(options) @chooseanduploadfile","description":"选择并上传文件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions) | 是 | - | - |\n#### UniCloudChooseAndUploadFileOptions 属性值 @unicloudchooseanduploadfileoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| sourceType | Array\\<[String](#string)\\> | 否 | - | - |\n| count | [Number](#number) | 否 | - | - |\n| sizeType | Array\\<[String](#string)\\> | 否 | - | - |\n| extension | Array\\<[String](#string)\\> | 否 | - | - |\n| compressed | [Boolean](#boolean) | 否 | - | - |\n| maxDuration | [Number](#number) | 否 | - | - |\n| camera | [String](#string) | 否 | - | - |\n| crop | ChooseImageCropOptions | 否 | - | - |\n| type | [String](#string) | 是 | - | - |\n| onChooseFile | (arg: [UniCloudChooseFileResult](#unicloudchoosefileresult)) => void | 否 | - | - |\n| onUploadProgress | (arg: [UniCloudChooseAndUploadFileProgressEvent](#unicloudchooseanduploadfileprogressevent)) => void | 否 | - | - |\n\n##### String 属性值 @string \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| toString | () => string | 是 | - | - |\n| charAt | (pos: number) => string | 是 | - | - |\n| charCodeAt | (index: number) => number | 是 | - | - |\n| concat | (strings?: Array\\) => string | 是 | - | - |\n| indexOf | (searchString: string, position?: number) => number | 是 | - | - |\n| lastIndexOf | (searchString: string, position?: number) => number | 是 | - | - |\n| localeCompare | (that: string) => number | 是 | - | - |\n| match | (regexp: string) => [RegExpMatchArray](#regexpmatcharray) | 是 | - | - |\n| replace | (searchValue: string, replaceValue: string) => string | 是 | - | - |\n| search | (regexp: string) => number | 是 | - | - |\n| slice | (start?: number, end?: number) => string | 是 | - | - |\n| split | (separator: string, limit?: number) => Array\\ | 是 | - | - |\n| substring | (start: number, end?: number) => string | 是 | - | - |\n| toLowerCase | () => string | 是 | - | - |\n| toLocaleLowerCase | (locales?: string) => string | 是 | - | - |\n| toUpperCase | () => string | 是 | - | - |\n| toLocaleUpperCase | (locales?: string) => string | 是 | - | - |\n| trim | () => string | 是 | - | - |\n| length | number | 是 | - | - |\n| substr | (from: number, length?: number) => string | 是 | - | - |\n| valueOf | () => string | 是 | - | - |\n| codePointAt | (pos: number) => number | 是 | - | - |\n| includes | (searchString: string, position?: number) => boolean | 是 | - | - |\n| endsWith | (searchString: string, endPosition?: number) => boolean | 是 | - | - |\n| normalize | (form: string) => string | 是 | - | - |\n| repeat | (count: number) => string | 是 | - | - |\n| startsWith | (searchString: string, position?: number) => boolean | 是 | - | - |\n| anchor | (name: string) => string | 是 | - | - |\n| big | () => string | 是 | - | - |\n| blink | () => string | 是 | - | - |\n| bold | () => string | 是 | - | - |\n| fixed | () => string | 是 | - | - |\n| fontcolor | (color: string) => string | 是 | - | - |\n| fontsize | (size: number) => string | 是 | - | - |\n| italics | () => string | 是 | - | - |\n| link | (url: string) => string | 是 | - | - |\n| small | () => string | 是 | - | - |\n| strike | () => string | 是 | - | - |\n| sub | () => string | 是 | - | - |\n| sup | () => string | 是 | - | - |\n| padStart | (maxLength: number, fillString?: string) => string | 是 | - | - |\n| padEnd | (maxLength: number, fillString?: string) => string | 是 | - | - |\n| trimEnd | () => string | 是 | - | - |\n| trimStart | () => string | 是 | - | - |\n| trimLeft | () => string | 是 | - | - |\n| trimRight | () => string | 是 | - | - |\n| matchAll | (regexp: any) => [IterableIterator\\](#iterableiterator) | 是 | - | - |\n| at | (index: number) => string | 是 | - | - |\n| __@iterator@275 | () => [IterableIterator\\](#iterableiterator) | 是 | - | - |\n\n##### Number 属性值 @number \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| toString | (radix?: number) => string | 是 | - | - |\n| toFixed | (fractionDigits?: number) => string | 是 | - | - |\n| toExponential | (fractionDigits?: number) => string | 是 | - | - |\n| toPrecision | (precision?: number) => string | 是 | - | - |\n| valueOf | () => number | 是 | - | - |\n| toLocaleString | (locales?: string, options?: [Intl.NumberFormatOptions](#intl)) => string | 是 | - | - |\n| toFloat | () => number | 是 | - | - |\n\n###### Intl.NumberFormatOptions 属性值 @intl \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| localeMatcher | string | 否 | - | - |\n| style | string | 否 | - | - |\n| currency | string | 否 | - | - |\n| currencySign | string | 否 | - | - |\n| useGrouping | boolean | 否 | - | - |\n| minimumIntegerDigits | number | 否 | - | - |\n| minimumFractionDigits | number | 否 | - | - |\n| maximumFractionDigits | number | 否 | - | - |\n| minimumSignificantDigits | number | 否 | - | - |\n| maximumSignificantDigits | number | 否 | - | - |\n| compactDisplay | string | 否 | - | - |\n| notation | string | 否 | - | - |\n| signDisplay | string | 否 | - | - |\n| unit | string | 否 | - | - |\n| unitDisplay | string | 否 | - | - |\n| currencyDisplay | string | 否 | - | - |\n\n##### Boolean 属性值 @boolean \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| valueOf | () => boolean | 是 | - | - |\n\n##### UniCloudChooseFileResult 属性值 @unicloudchoosefileresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| tempFiles | Array\\<[UniCloudChooseFileItem](#unicloudchoosefileitem)\\> | 是 | - | - |\n| tempFilePaths | Array\\ | 是 | - | - |\n\n###### UniCloudChooseFileItem 属性值 @unicloudchoosefileitem \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | - |\n| path | string | 是 | - | - |\n| cloudPath | string | 是 | - | - |\n| cloudPathAsRealPath | boolean | 否 | - | - |\n| url | string | 否 | - | - |\n| errMsg | string | 否 | - | - |\n\n##### UniCloudChooseAndUploadFileProgressEvent 属性值 @unicloudchooseanduploadfileprogressevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | - |\n| loaded | number | 是 | - | - |\n| total | number | 是 | - | - |\n| tempFilePath | string | 是 | - | - |\n| tempFile | [UniCloudChooseFileItem](#unicloudchoosefileitem) | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudChooseAndUploadFileResult](#unicloudchooseanduploadfileresult)> | \n\n#### UniCloudChooseAndUploadFileResult 属性值 @unicloudchooseanduploadfileresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| tempFiles | Array\\<[UniCloudChooseFileItem](#unicloudchoosefileitem)\\> | 是 | - | - |\n| tempFilePaths | Array\\ | 是 | - | - |\n\n##### UniCloudChooseFileItem 属性值 @unicloudchoosefileitem \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | - |\n| path | string | 是 | - | - |\n| cloudPath | string | 是 | - | - |\n| cloudPathAsRealPath | boolean | 否 | - | - |\n| url | string | 否 | - | - |\n| errMsg | string | 否 | - | - |\n","compatibility":"### chooseAndUploadFile 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.9.0 仅支持阿里云 | - | √ | x |\n","tutorial":""}} \ No newline at end of file +{"uniCloud_props":{"name":"# uniCloud","description":"","param":"## 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| config | [UniCloudInitOptions](#unicloudinitoptions) | 是 | - | - |\n### UniCloudInitOptions 属性值 @unicloudinitoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| provider | string | 是 | - | 服务商，目前支持 aliyun、tencent |\n| spaceName | string | 否 | - | 服务空间名 |\n| spaceId | string | 是 | - | 服务空间id |\n| clientSecret | string | 否 | - | 阿里云clientSecret |\n| endpoint | string | 否 | - | 阿里云endpoint |\n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"## callFunction(options) @callfunction","description":"请求云函数","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudCallFunctionOptions](#unicloudcallfunctionoptions) | 是 | - | - |\n#### UniCloudCallFunctionOptions 属性值 @unicloudcallfunctionoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | 云函数名 |\n| data | any | 否 | - | 云函数参数 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudCallFunctionResult](#unicloudcallfunctionresult)> | \n\n#### UniCloudCallFunctionResult 属性值 @unicloudcallfunctionresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| result | any | 是 | - | 云函数参数 |\n| requestId | string | 否 | - | 云函数请求id |\n","compatibility":"### callFunction 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"uploadFile":{"name":"## uploadFile(options) @uploadfile","description":"上传文件到云存储","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions) | 是 | - | - |\n#### UniCloudUploadFileOptions 属性值 @uniclouduploadfileoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | 文件路径 |\n| cloudPath | string | 是 | - | 云端路径 |\n| cloudPathAsRealPath | boolean | 否 | - | 是否以云端路径是否为真实路径保存上传的文件 |\n| onUploadProgress | (options: [UniCloudUploadProgress](#uniclouduploadprogress)) => any | 否 | - | 上传进度回调 |\n\n##### UniCloudUploadProgress 属性值 @uniclouduploadprogress \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| loaded | number | 是 | - | 已上传大小 |\n| total | number | 是 | - | 总大小 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudUploadFileResult](#uniclouduploadfileresult)> | \n\n#### UniCloudUploadFileResult 属性值 @uniclouduploadfileresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| filePath | string | 是 | - | 文件路径 |\n| fileID | string | 是 | - | 文件id |\n","compatibility":"### uploadFile 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"getTempFileURL":{"name":"## getTempFileURL(options) @gettempfileurl","description":"获取文件临时URL","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudGetTempFileURLOptions](#unicloudgettempfileurloptions) | 是 | - | - |\n#### UniCloudGetTempFileURLOptions 属性值 @unicloudgettempfileurloptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fileList | Array\\ | 是 | - | 文件列表 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudGetTempFileURLResult](#unicloudgettempfileurlresult)> | \n\n#### UniCloudGetTempFileURLResult 属性值 @unicloudgettempfileurlresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fileList | Array\\<[UniCloudGetTempFileURLResultItem](#unicloudgettempfileurlresultitem)\\> | 是 | - | 文件列表 |\n\n##### UniCloudGetTempFileURLResultItem 属性值 @unicloudgettempfileurlresultitem \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| fileID | string | 是 | - | 文件id |\n| tempFileURL | string | 是 | - | 文件临时url |\n","compatibility":"### getTempFileURL 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"importObject":{"name":"## importObject(objectName, options?) @importobject","description":"引用云对象","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| objectName | string | 是 | - | - |\n| options | [UniCloudImportObjectOptions](#unicloudimportobjectoptions) | 否 | - | - |\n#### UniCloudImportObjectOptions 属性值 @unicloudimportobjectoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| customUI | boolean | 否 | - | 是否移除自动展示的ui |\n| loadingOptions | [UniCloudImportObjectLoadingOptions](#unicloudimportobjectloadingoptions) | 否 | - | loading界面配置 |\n| errorOptions | [UniCloudImportObjectErrorOptions](#unicloudimportobjecterroroptions) | 否 | - | 错误提示配置 |\n\n##### UniCloudImportObjectLoadingOptions 属性值 @unicloudimportobjectloadingoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| title | string | 否 | - | 加载框标题 |\n| mask | boolean | 否 | - | 是否移除自动展示的ui |\n\n##### UniCloudImportObjectErrorOptions 属性值 @unicloudimportobjecterroroptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 否 | - | 加载框标题 |\n| retry | boolean | 否 | - | 是否移除自动展示的ui |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"### importObject 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"onResponse":{"name":"## onResponse(callback) @onresponse","description":"监听响应事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onResponse 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"offResponse":{"name":"## offResponse(callback) @offresponse","description":"移除响应事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offResponse 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"onRefreshToken":{"name":"## onRefreshToken(callback) @onrefreshtoken","description":"监听token刷新事件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### onRefreshToken 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"offRefreshToken":{"name":"## offRefreshToken(callback) @offrefreshtoken","description":"移除token刷新事件监听","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent)) => any | 是 | - | - |\n#### UniCloudResponseEvent 属性值 @unicloudresponseevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| type | string | 是 | - | 响应事件类型 |\n| name | string | 是 | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | 响应结果、错误内容 |\n","returnValue":"","compatibility":"### offRefreshToken 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"databaseForJQL":{"name":"## databaseForJQL() @databaseforjql","description":"获取数据库操作实例","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [Database](#database) | \n\n#### Database 属性值 @database \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| ctors | Constructor | 是 | - | - |\n| _client | any | 是 | - | - |\n| collection | (args?: Array\\) => [Collection](#collection) | 是 | - | - |\n| command | any | 是 | - | - |\n| Geo | any | 是 | - | - |\n","compatibility":"### databaseForJQL 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"getCurrentUserInfo":{"name":"## getCurrentUserInfo() @getcurrentuserinfo","description":"获取token内缓存的用户信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudUserInfo](#uniclouduserinfo) | \n\n#### UniCloudUserInfo 属性值 @uniclouduserinfo \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| uid | string | 否 | - | UserInfo = { / |\n| role | Array\\ | 是 | - | ing \\| null; / |\n| permission | Array\\ | 是 | - | ay\\; / |\n| tokenExpired | number | 是 | - | ay\\; /** |\n","compatibility":"### getCurrentUserInfo 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""},"chooseAndUploadFile":{"name":"## chooseAndUploadFile(options) @chooseanduploadfile","description":"选择并上传文件","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions) | 是 | - | - |\n#### UniCloudChooseAndUploadFileOptions 属性值 @unicloudchooseanduploadfileoptions \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| sourceType | Array\\<[String](#string)\\> | 否 | - | - |\n| count | [Number](#number) | 否 | - | - |\n| sizeType | Array\\<[String](#string)\\> | 否 | - | - |\n| extension | Array\\<[String](#string)\\> | 否 | - | - |\n| compressed | [Boolean](#boolean) | 否 | - | - |\n| maxDuration | [Number](#number) | 否 | - | - |\n| camera | [String](#string) | 否 | - | - |\n| crop | ChooseImageCropOptions | 否 | - | - |\n| type | [String](#string) | 是 | - | - |\n| onChooseFile | (arg: [UniCloudChooseFileResult](#unicloudchoosefileresult)) => void | 否 | - | - |\n| onUploadProgress | (arg: [UniCloudChooseAndUploadFileProgressEvent](#unicloudchooseanduploadfileprogressevent)) => void | 否 | - | - |\n\n##### String 属性值 @string \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| toString | () => string | 是 | - | - |\n| charAt | (pos: number) => string | 是 | - | - |\n| charCodeAt | (index: number) => number | 是 | - | - |\n| concat | (strings?: Array\\) => string | 是 | - | - |\n| indexOf | (searchString: string, position?: number) => number | 是 | - | - |\n| lastIndexOf | (searchString: string, position?: number) => number | 是 | - | - |\n| localeCompare | (that: string) => number | 是 | - | - |\n| match | (regexp: string) => [RegExpMatchArray](#regexpmatcharray) | 是 | - | - |\n| replace | (searchValue: string, replaceValue: string) => string | 是 | - | - |\n| search | (regexp: string) => number | 是 | - | - |\n| slice | (start?: number, end?: number) => string | 是 | - | - |\n| split | (separator: string, limit?: number) => Array\\ | 是 | - | - |\n| substring | (start: number, end?: number) => string | 是 | - | - |\n| toLowerCase | () => string | 是 | - | - |\n| toLocaleLowerCase | (locales?: string) => string | 是 | - | - |\n| toUpperCase | () => string | 是 | - | - |\n| toLocaleUpperCase | (locales?: string) => string | 是 | - | - |\n| trim | () => string | 是 | - | - |\n| length | number | 是 | - | - |\n| substr | (from: number, length?: number) => string | 是 | - | - |\n| valueOf | () => string | 是 | - | - |\n| codePointAt | (pos: number) => number | 是 | - | - |\n| includes | (searchString: string, position?: number) => boolean | 是 | - | - |\n| endsWith | (searchString: string, endPosition?: number) => boolean | 是 | - | - |\n| normalize | (form: string) => string | 是 | - | - |\n| repeat | (count: number) => string | 是 | - | - |\n| startsWith | (searchString: string, position?: number) => boolean | 是 | - | - |\n| anchor | (name: string) => string | 是 | - | - |\n| big | () => string | 是 | - | - |\n| blink | () => string | 是 | - | - |\n| bold | () => string | 是 | - | - |\n| fixed | () => string | 是 | - | - |\n| fontcolor | (color: string) => string | 是 | - | - |\n| fontsize | (size: number) => string | 是 | - | - |\n| italics | () => string | 是 | - | - |\n| link | (url: string) => string | 是 | - | - |\n| small | () => string | 是 | - | - |\n| strike | () => string | 是 | - | - |\n| sub | () => string | 是 | - | - |\n| sup | () => string | 是 | - | - |\n| padStart | (maxLength: number, fillString?: string) => string | 是 | - | - |\n| padEnd | (maxLength: number, fillString?: string) => string | 是 | - | - |\n| trimEnd | () => string | 是 | - | - |\n| trimStart | () => string | 是 | - | - |\n| trimLeft | () => string | 是 | - | - |\n| trimRight | () => string | 是 | - | - |\n| matchAll | (regexp: any) => [IterableIterator\\](#iterableiterator) | 是 | - | - |\n| at | (index: number) => string | 是 | - | - |\n| __@iterator@275 | () => [IterableIterator\\](#iterableiterator) | 是 | - | - |\n\n##### Number 属性值 @number \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| toString | (radix?: number) => string | 是 | - | - |\n| toFixed | (fractionDigits?: number) => string | 是 | - | - |\n| toExponential | (fractionDigits?: number) => string | 是 | - | - |\n| toPrecision | (precision?: number) => string | 是 | - | - |\n| valueOf | () => number | 是 | - | - |\n| toLocaleString | (locales?: string, options?: [Intl.NumberFormatOptions](#intl)) => string | 是 | - | - |\n| toFloat | () => number | 是 | - | - |\n\n###### Intl.NumberFormatOptions 属性值 @intl \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| localeMatcher | string | 否 | - | - |\n| style | string | 否 | - | - |\n| currency | string | 否 | - | - |\n| currencySign | string | 否 | - | - |\n| useGrouping | boolean | 否 | - | - |\n| minimumIntegerDigits | number | 否 | - | - |\n| minimumFractionDigits | number | 否 | - | - |\n| maximumFractionDigits | number | 否 | - | - |\n| minimumSignificantDigits | number | 否 | - | - |\n| maximumSignificantDigits | number | 否 | - | - |\n| compactDisplay | string | 否 | - | - |\n| notation | string | 否 | - | - |\n| signDisplay | string | 否 | - | - |\n| unit | string | 否 | - | - |\n| unitDisplay | string | 否 | - | - |\n| currencyDisplay | string | 否 | - | - |\n\n##### Boolean 属性值 @boolean \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| valueOf | () => boolean | 是 | - | - |\n\n##### UniCloudChooseFileResult 属性值 @unicloudchoosefileresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| tempFiles | Array\\<[UniCloudChooseFileItem](#unicloudchoosefileitem)\\> | 是 | - | - |\n| tempFilePaths | Array\\ | 是 | - | - |\n\n###### UniCloudChooseFileItem 属性值 @unicloudchoosefileitem \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | - |\n| path | string | 是 | - | - |\n| cloudPath | string | 是 | - | - |\n| cloudPathAsRealPath | boolean | 否 | - | - |\n| url | string | 否 | - | - |\n| errMsg | string | 否 | - | - |\n\n##### UniCloudChooseAndUploadFileProgressEvent 属性值 @unicloudchooseanduploadfileprogressevent \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| index | number | 是 | - | - |\n| loaded | number | 是 | - | - |\n| total | number | 是 | - | - |\n| tempFilePath | string | 是 | - | - |\n| tempFile | [UniCloudChooseFileItem](#unicloudchoosefileitem) | 是 | - | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise<[UniCloudChooseAndUploadFileResult](#unicloudchooseanduploadfileresult)> | \n\n#### UniCloudChooseAndUploadFileResult 属性值 @unicloudchooseanduploadfileresult \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| tempFiles | Array\\<[UniCloudChooseFileItem](#unicloudchoosefileitem)\\> | 是 | - | - |\n| tempFilePaths | Array\\ | 是 | - | - |\n\n##### UniCloudChooseFileItem 属性值 @unicloudchoosefileitem \n\n| 名称 | 类型 | 必填 | 默认值 | 描述 |\n| :- | :- | :- | :- | :- |\n| name | string | 是 | - | - |\n| path | string | 是 | - | - |\n| cloudPath | string | 是 | - | - |\n| cloudPathAsRealPath | boolean | 否 | - | - |\n| url | string | 否 | - | - |\n| errMsg | string | 否 | - | - |\n","compatibility":"### chooseAndUploadFile 兼容性 \n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | √ | 3.91 仅支持阿里云 | - | √ | x |\n","tutorial":""}} \ No newline at end of file