Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
enjoyphenix
unidocs-zh
提交
6a1a7efc
unidocs-zh
项目概览
enjoyphenix
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode，发现更多精彩内容 >>
提交
6a1a7efc
编写于
10月 12, 2023
作者:
D
DCloud_LXH
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
chore: uts api json 、uts unicloud api json
上级
e77ac75f
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
2 addition
and
2 deletion
+2
-2
docs/.vuepress/utils/utsApiJson.json
docs/.vuepress/utils/utsApiJson.json
+1
-1
docs/.vuepress/utils/utsUnicloudApiJson.json
docs/.vuepress/utils/utsUnicloudApiJson.json
+1
-1
未找到文件。
docs/.vuepress/utils/utsApiJson.json
浏览文件 @
6a1a7efc
因为 它太大了无法显示 source diff 。你可以改为
查看blob
。
docs/.vuepress/utils/utsUnicloudApiJson.json
浏览文件 @
6a1a7efc
{
"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，腾讯云 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.9，腾讯云 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
\\
<string
\\
> | 是 | - | 文件列表 |
\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，腾讯云 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) | 否 | - | - |
\n
| errorOptions | [UniCloudImportObjectErrorOptions](#unicloudimportobjecterroroptions) | 否 | - | - |
\n\n
##### UniCloudImportObjectLoadingOptions 属性值 @unicloudimportobjectloadingoptions
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| title | string | 否 | - | 加载框标题 |
\n
| mask | boolean | 否 | - | 加载框是否显示mask |
\n\n
##### UniCloudImportObjectErrorOptions 属性值 @unicloudimportobjecterroroptions
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| type | string | 否 | - | 错误提示类型，可以是modal或者toast |
\n
| retry | boolean | 否 | - | 是否显示重试按钮 |
\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，腾讯云 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.9，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offResponse"
:{
"name"
:
"## offResponse(callback) @offresponse"
,
"description"
:
"移除响应事件监听"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| callback | (arg: any) => any | 是 | - | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### offResponse 兼容性
\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :- | :- | :- | :- | :- | :- |
\n
| 5.0 | √ | 阿里云 3.9，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"onRefreshToken"
:{
"name"
:
"## onRefreshToken(callback) @onrefreshtoken"
,
"description"
:
"监听token刷新事件"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| callback | (arg: any) => any | 是 | - | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### onRefreshToken 兼容性
\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :- | :- | :- | :- | :- | :- |
\n
| 5.0 | √ | 阿里云 3.9，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offRefreshToken"
:{
"name"
:
"## offRefreshToken(callback) @offrefreshtoken"
,
"description"
:
"移除token刷新事件监听"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| callback | (arg: any) => any | 是 | - | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### offRefreshToken 兼容性
\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :- | :- | :- | :- | :- | :- |
\n
| 5.0 | √ | 阿里云 3.9，腾讯云 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
\\
<any
\\
>) => [Collection](#collection) | 是 | - | - |
\n
| command | any | 是 | - | - |
\n
| Geo | any | 是 | - | - |
\n\n
##### Collection 属性值 @collection
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| ctors | Constructor | 是 | - | - |
\n
| _client | any | 是 | - | - |
\n
| _collectionList | any | 是 | - | - |
\n
| _stages | any | 是 | - | - |
\n
| where | (condition: any) => [UniCloudDBFilter](#uniclouddbfilter) | 是 | - | - |
\n
| doc | (docId: string) => [UniCloudDBFilter](#uniclouddbfilter) | 是 | - | - |
\n
| aggregate | () => [UniCloudDBFilter](#uniclouddbfilter) | 是 | - | - |
\n
| foreignKey | (foreignKey: string) => [UniCloudDBFilter](#uniclouddbfilter) | 是 | - | - |
\n
| add | (data: any) => Promise<[UniCloudDBAddResult](#uniclouddbaddresult)> | 是 | - | - |
\n
| get | (arg?: any) => Promise<[UniCloudDBGetResult](#uniclouddbgetresult)> | 是 | - | - |
\n
| count | () => Promise<[UniCloudDBCountResult](#uniclouddbcountresult)> | 是 | - | - |
\n
| getTemp | () => any | 是 | - | - |
\n
| field | (filed: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| skip | (num: number) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| limit | (num: number) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| orderBy | (order: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n\n
###### UniCloudDBFilter 属性值 @uniclouddbfilter
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| ctors | Constructor | 是 | - | - |
\n
| _client | any | 是 | - | - |
\n
| _stages | any | 是 | - | - |
\n
| get | (arg?: any) => Promise<[UniCloudDBGetResult](#uniclouddbgetresult)> | 是 | - | - |
\n
| count | () => Promise<[UniCloudDBCountResult](#uniclouddbcountresult)> | 是 | - | - |
\n
| update | (data: any) => Promise<[UniCloudDBUpdateResult](#uniclouddbupdateresult)> | 是 | - | - |
\n
| remove | () => Promise<[UniCloudDBRemoveResult](#uniclouddbremoveresult)> | 是 | - | - |
\n
| getTemp | () => any | 是 | - | - |
\n
| where | (condition: any) => [UniCloudDBFilter](#uniclouddbfilter) | 是 | - | - |
\n
| doc | (docId: string) => [UniCloudDBFilter](#uniclouddbfilter) | 是 | - | - |
\n
| field | (filed: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| skip | (num: number) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| limit | (num: number) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| orderBy | (order: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| groupBy | (field: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| groupField | (field: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| distinct | (field: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| geoNear | (options: any) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n\n
####### UniCloudDBGetResult 属性值 @uniclouddbgetresult
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| data | Array
\\
<any
\\
> | 是 | - | etResult = { /** |
\n
| count | number | 否 | - | JSONObject>; /** |
\n
| requestId | string | 否 | - | ber
\\
| null; / |
\n\n
####### UniCloudDBCountResult 属性值 @uniclouddbcountresult
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| total | number | 是 | - | ntResult = { /** |
\n
| requestId | string | 否 | - | al: number; / |
\n\n
####### UniCloudDBUpdateResult 属性值 @uniclouddbupdateresult
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| updated | number | 是 | - | teResult = { /** |
\n
| requestId | string | 否 | - | ted: number; / |
\n\n
####### UniCloudDBRemoveResult 属性值 @uniclouddbremoveresult
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| deleted | number | 是 | - | veResult = { /** |
\n
| requestId | string | 否 | - | ted: number; / |
\n\n
####### UniCloudDBQuery 属性值 @uniclouddbquery
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| ctors | Constructor | 是 | - | - |
\n
| _client | any | 是 | - | - |
\n
| _stages | any | 是 | - | - |
\n
| get | (arg?: any) => Promise<[UniCloudDBGetResult](#uniclouddbgetresult)> | 是 | - | - |
\n
| count | () => Promise<[UniCloudDBCountResult](#uniclouddbcountresult)> | 是 | - | - |
\n
| getTemp | () => any | 是 | - | - |
\n
| field | (filed: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| skip | (num: number) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| limit | (num: number) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| orderBy | (order: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| groupBy | (field: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| groupField | (field: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| distinct | (field: string) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n
| geoNear | (options: any) => [UniCloudDBQuery](#uniclouddbquery) | 是 | - | - |
\n\n
###### UniCloudDBAddResult 属性值 @uniclouddbaddresult
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| id | string | 是 | - | ddResult = { /** |
\n
| requestId | string | 否 | - | string; / |
\n
"
,
"compatibility"
:
"### databaseForJQL 兼容性
\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :- | :- | :- | :- | :- | :- |
\n
| 5.0 | √ | 阿里云 3.91，腾讯云 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
\\
<string
\\
> | 是 | - | ing
\\
| null; / |
\n
| permission | Array
\\
<string
\\
> | 是 | - | ay
\\
<string>; / |
\n
| tokenExpired | number | 是 | - | ay
\\
<string>; /** |
\n
"
,
"compatibility"
:
"### getCurrentUserInfo 兼容性
\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :- | :- | :- | :- | :- | :- |
\n
| 5.0 | √ | 阿里云 3.9，腾讯云 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
\\
>) => string | 是 | - | - |
\n
| indexOf | (searchString: string, position?: number) => number | 是 | - | - |
\n
| lastIndexOf | (searchString: string, position?: number) => number | 是 | - | - |
\n
| localeCompare | (that: string) => number | 是 | - | - |
\n
| match | (regexp: string
\\\\
| interface) => [RegExpMatchArray](#regexpmatcharray) | 是 | - | - |
\n
| replace | (searchValue: string
\\\\
| interface, replaceValue: string) => string | 是 | - | - |
\n
| search | (regexp: string
\\\\
| interface) => number | 是 | - | - |
\n
| slice | (start?: number, end?: number) => string | 是 | - | - |
\n
| split | (separator: string
\\\\
| interface, limit?: number) => Array
\\
<string
\\
> | 是 | - | - |
\n
| substring | (start: number, end?: number) => string | 是 | - | - |
\n
| toLowerCase | () => string | 是 | - | - |
\n
| toLocaleLowerCase | (locales?: string
\\\\
| Array) => string | 是 | - | - |
\n
| toUpperCase | () => string | 是 | - | - |
\n
| toLocaleUpperCase | (locales?: string
\\\\
| Array) => string | 是 | - | - |
\n
| trim | () => string | 是 | - | - |
\n
| length | number | 是 | - | - |
\n
| substr | (from: number, length?: number) => string | 是 | - | - |
\n
| valueOf | () => string | 是 | - | - |
\n
| codePointAt | (pos: number) => number
\\\\
| any | 是 | - | - |
\n
| includes | (searchString: string, position?: number) => boolean | 是 | - | - |
\n
| endsWith | (searchString: string, endPosition?: number) => boolean | 是 | - | - |
\n
| normalize | (form: NFC
\\\\
| NFD
\\\\
| NFKC
\\\\
| NFKD) => 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: [RegExp](#regexp)) => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| at | (index: number) => string | 是 | - | - |
\n
| __@iterator@283 | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n\n
###### RegExpMatchArray 属性值 @regexpmatcharray
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| 0 | string | 是 | - | - |
\n
| index | number | 否 | - | - |
\n
| input | string | 否 | - | - |
\n
| groups | [{ [key: string
\\
]: string; }](#key) | 否 | - | - |
\n
| length | number | 是 | - | - |
\n
| toString | () => string | 是 | - | - |
\n
| toLocaleString | () => string | 是 | - | - |
\n
| pop | () => any
\\\\
| any | 是 | - | - |
\n
| push | (items?: Array
\\
<any
\\
>) => number | 是 | - | - |
\n
| concat | (items?: Array
\\
<any
\\
>) => Array
\\
<any
\\
> | 是 | - | - |
\n
| join | (separator?: string) => string | 是 | - | - |
\n
| reverse | () => Array
\\
<any
\\
> | 是 | - | - |
\n
| shift | () => any
\\\\
| any | 是 | - | - |
\n
| slice | (start?: number, end?: number) => Array
\\
<any
\\
> | 是 | - | - |
\n
| sort | (compareFn?: (a: any, b: any) => number) => any | 是 | - | - |
\n
| splice | (start: number, deleteCount?: number) => Array
\\
<any
\\
> | 是 | - | - |
\n
| unshift | (items?: Array
\\
<any
\\
>) => number | 是 | - | - |
\n
| indexOf | (searchElement: any, fromIndex?: number) => number | 是 | - | - |
\n
| lastIndexOf | (searchElement: any, fromIndex?: number) => number | 是 | - | - |
\n
| every | (predicate: (value: any, index: number, array: Array
\\
<any
\\
>) => boolean, thisArg?: any) => boolean | 是 | - | - |
\n
| some | (predicate: (value: any, index: number, array: Array
\\
<any
\\
>) => any, thisArg?: any) => boolean | 是 | - | - |
\n
| forEach | (callbackfn: (value: any, index: number, array: Array
\\
<any
\\
>) => void, thisArg?: any) => void | 是 | - | - |
\n
| map | (callbackfn: (value: any, index: number, array: Array
\\
<any
\\
>) => any, thisArg?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| filter | (predicate: (value: any, index: number, array: Array
\\
<any
\\
>) => boolean, thisArg?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| reduce | (callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Array
\\
<any
\\
>) => any) => any | 是 | - | - |
\n
| reduceRight | (callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Array
\\
<any
\\
>) => any) => any | 是 | - | - |
\n
| find | (predicate: (this: void, value: any, index: number, obj: Array
\\
<any
\\
>) => boolean, thisArg?: any) => any
\\\\
| any | 是 | - | - |
\n
| findIndex | (predicate: (value: any, index: number, obj: Array
\\
<any
\\
>) => any, thisArg?: any) => number | 是 | - | - |
\n
| fill | (value: any, start?: number, end?: number) => any | 是 | - | - |
\n
| copyWithin | (target: number, start: number, end?: number) => any | 是 | - | - |
\n
| entries | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| keys | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| values | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| includes | (searchElement: any, fromIndex?: number) => boolean | 是 | - | - |
\n
| flatMap | (callback: (this: any, value: any, index: number, array: Array
\\
<any
\\
>) => any
\\\\
| interface, thisArg?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| flat | (this: any, depth?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| __@iterator@283 | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| __@unscopables@3106 | () => [{ copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }](#copywithin) | 是 | - | - |
\n
| at | (index: number) => any
\\\\
| any | 是 | - | Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array. |
\n\n
####### IterableIterator
\\
<T> 属性值 @iterableiterator
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| __@iterator@283 | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| next | (args?: any
\\\\
| any) => any | 是 | - | - |
\n
| return | (value?: any) => any | 否 | - | - |
\n
| throw | (e?: any) => any | 否 | - | - |
\n\n
####### { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; } 属性值 @copywithin
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| copyWithin | boolean | 是 | - | - |
\n
| entries | boolean | 是 | - | - |
\n
| fill | boolean | 是 | - | - |
\n
| find | boolean | 是 | - | - |
\n
| findIndex | boolean | 是 | - | - |
\n
| keys | boolean | 是 | - | - |
\n
| values | boolean | 是 | - | - |
\n\n
###### RegExp 属性值 @regexp
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| exec | (string: string) => [RegExpExecArray](#regexpexecarray) | 是 | - | - |
\n
| test | (string: string) => boolean | 是 | - | - |
\n
| source | string | 是 | - | - |
\n
| global | boolean | 是 | - | - |
\n
| ignoreCase | boolean | 是 | - | - |
\n
| multiline | boolean | 是 | - | - |
\n
| lastIndex | number | 是 | - | - |
\n
| compile | (pattern: string, flags?: string) => any | 是 | - | - |
\n
| flags | string | 是 | - | - |
\n
| sticky | boolean | 是 | - | - |
\n
| unicode | boolean | 是 | - | - |
\n
| dotAll | boolean | 是 | - | - |
\n
| __@match@318 | (string: string) => [RegExpMatchArray](#regexpmatcharray) | 是 | - | - |
\n
| __@replace@3091 | (string: string, replaceValue: string) => string | 是 | - | - |
\n
| __@search@3094 | (string: string) => number | 是 | - | - |
\n
| __@split@3096 | (string: string, limit?: number) => Array
\\
<string
\\
> | 是 | - | - |
\n
| __@matchAll@3098 | (str: string) => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n\n
####### RegExpExecArray 属性值 @regexpexecarray
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| 0 | string | 是 | - | - |
\n
| index | number | 是 | - | - |
\n
| input | string | 是 | - | - |
\n
| groups | [{ [key: string
\\
]: string; }](#key) | 否 | - | - |
\n
| length | number | 是 | - | - |
\n
| toString | () => string | 是 | - | - |
\n
| toLocaleString | () => string | 是 | - | - |
\n
| pop | () => any
\\\\
| any | 是 | - | - |
\n
| push | (items?: Array
\\
<any
\\
>) => number | 是 | - | - |
\n
| concat | (items?: Array
\\
<any
\\
>) => Array
\\
<any
\\
> | 是 | - | - |
\n
| join | (separator?: string) => string | 是 | - | - |
\n
| reverse | () => Array
\\
<any
\\
> | 是 | - | - |
\n
| shift | () => any
\\\\
| any | 是 | - | - |
\n
| slice | (start?: number, end?: number) => Array
\\
<any
\\
> | 是 | - | - |
\n
| sort | (compareFn?: (a: any, b: any) => number) => any | 是 | - | - |
\n
| splice | (start: number, deleteCount?: number) => Array
\\
<any
\\
> | 是 | - | - |
\n
| unshift | (items?: Array
\\
<any
\\
>) => number | 是 | - | - |
\n
| indexOf | (searchElement: any, fromIndex?: number) => number | 是 | - | - |
\n
| lastIndexOf | (searchElement: any, fromIndex?: number) => number | 是 | - | - |
\n
| every | (predicate: (value: any, index: number, array: Array
\\
<any
\\
>) => boolean, thisArg?: any) => boolean | 是 | - | - |
\n
| some | (predicate: (value: any, index: number, array: Array
\\
<any
\\
>) => any, thisArg?: any) => boolean | 是 | - | - |
\n
| forEach | (callbackfn: (value: any, index: number, array: Array
\\
<any
\\
>) => void, thisArg?: any) => void | 是 | - | - |
\n
| map | (callbackfn: (value: any, index: number, array: Array
\\
<any
\\
>) => any, thisArg?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| filter | (predicate: (value: any, index: number, array: Array
\\
<any
\\
>) => boolean, thisArg?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| reduce | (callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Array
\\
<any
\\
>) => any) => any | 是 | - | - |
\n
| reduceRight | (callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: Array
\\
<any
\\
>) => any) => any | 是 | - | - |
\n
| find | (predicate: (this: void, value: any, index: number, obj: Array
\\
<any
\\
>) => boolean, thisArg?: any) => any
\\\\
| any | 是 | - | - |
\n
| findIndex | (predicate: (value: any, index: number, obj: Array
\\
<any
\\
>) => any, thisArg?: any) => number | 是 | - | - |
\n
| fill | (value: any, start?: number, end?: number) => any | 是 | - | - |
\n
| copyWithin | (target: number, start: number, end?: number) => any | 是 | - | - |
\n
| entries | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| keys | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| values | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| includes | (searchElement: any, fromIndex?: number) => boolean | 是 | - | - |
\n
| flatMap | (callback: (this: any, value: any, index: number, array: Array
\\
<any
\\
>) => any
\\\\
| interface, thisArg?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| flat | (this: any, depth?: any) => Array
\\
<any
\\
> | 是 | - | - |
\n
| __@iterator@283 | () => [IterableIterator
\\
<T>](#iterableiterator) | 是 | - | - |
\n
| __@unscopables@3106 | () => [{ copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }](#copywithin) | 是 | - | - |
\n
| at | (index: number) => any
\\\\
| any | 是 | - | Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array. |
\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
\\\\
| Array, options?: [Intl.NumberFormatOptions](#intl)) => string | 是 | - | - |
\n
| toFloat | () => number | 是 | - | - |
\n\n
###### Intl.NumberFormatOptions 属性值 @intl
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| localeMatcher | string
\\\\
| any | 否 | - | - |
\n
| style | string
\\\\
| any | 否 | - | - |
\n
| currency | string
\\\\
| any | 否 | - | - |
\n
| currencySign | string
\\\\
| any | 否 | - | - |
\n
| useGrouping | boolean
\\\\
| any | 否 | - | - |
\n
| minimumIntegerDigits | number
\\\\
| any | 否 | - | - |
\n
| minimumFractionDigits | number
\\\\
| any | 否 | - | - |
\n
| maximumFractionDigits | number
\\\\
| any | 否 | - | - |
\n
| minimumSignificantDigits | number
\\\\
| any | 否 | - | - |
\n
| maximumSignificantDigits | number
\\\\
| any | 否 | - | - |
\n
| compactDisplay | short
\\\\
| long
\\\\
| any | 否 | - | - |
\n
| notation | standard
\\\\
| scientific
\\\\
| engineering
\\\\
| compact
\\\\
| any | 否 | - | - |
\n
| signDisplay | auto
\\\\
| never
\\\\
| always
\\\\
| exceptZero
\\\\
| any | 否 | - | - |
\n
| unit | string
\\\\
| any | 否 | - | - |
\n
| unitDisplay | short
\\\\
| long
\\\\
| narrow
\\\\
| any | 否 | - | - |
\n
| currencyDisplay | string
\\\\
| any | 否 | - | - |
\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
\\
<string
\\
> | 是 | - | - |
\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
\\
<string
\\
> | 是 | - | - |
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
}}
\ No newline at end of file
{
"uniCloud_props"
:{
"name"
:
"# uniCloud"
,
"description"
:
""
,
"param"
:
"## 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| config | [UniCloudInitOptions](#unicloudinitoptions-values) | 是 | - | - |
\n
### UniCloudInitOptions 属性值 @unicloudinitoptions-values
\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-values) | 是 | - | - |
\n
#### UniCloudCallFunctionOptions 属性值 @unicloudcallfunctionoptions-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| name | string | 是 | - | 云函数名 |
\n
| data | any | 否 | - | 云函数参数 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :- |
\n
| Promise<[UniCloudCallFunctionResult](#unicloudcallfunctionresult-values)> |
\n\n
#### UniCloudCallFunctionResult 属性值 @unicloudcallfunctionresult-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"uploadFile"
:{
"name"
:
"## uploadFile(options) @uploadfile"
,
"description"
:
"上传文件到云存储"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) | 是 | - | - |
\n
#### UniCloudUploadFileOptions 属性值 @uniclouduploadfileoptions-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| filePath | string | 是 | - | 文件路径 |
\n
| cloudPath | string | 是 | - | 云端路径 |
\n
| cloudPathAsRealPath | boolean | 否 | - | 是否以云端路径是否为真实路径保存上传的文件 |
\n
| onUploadProgress | (options: [UniCloudUploadProgress](#uniclouduploadprogress-values)) => any | 否 | - | 上传进度回调 |
\n\n
##### UniCloudUploadProgress 属性值 @uniclouduploadprogress-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| loaded | number | 是 | - | 已上传大小 |
\n
| total | number | 是 | - | 总大小 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :- |
\n
| Promise<[UniCloudUploadFileResult](#uniclouduploadfileresult-values)> |
\n\n
#### UniCloudUploadFileResult 属性值 @uniclouduploadfileresult-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"getTempFileURL"
:{
"name"
:
"## getTempFileURL(options) @gettempfileurl"
,
"description"
:
"获取文件临时URL"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| options | [UniCloudGetTempFileURLOptions](#unicloudgettempfileurloptions-values) | 是 | - | - |
\n
#### UniCloudGetTempFileURLOptions 属性值 @unicloudgettempfileurloptions-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| fileList | Array
\\
<string
\\
> | 是 | - | 文件列表 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :- |
\n
| Promise<[UniCloudGetTempFileURLResult](#unicloudgettempfileurlresult-values)> |
\n\n
#### UniCloudGetTempFileURLResult 属性值 @unicloudgettempfileurlresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| fileList | Array
\\
<[UniCloudGetTempFileURLResultItem](#unicloudgettempfileurlresultitem-values)
\\
> | 是 | - | 文件列表 |
\n\n
##### UniCloudGetTempFileURLResultItem 属性值 @unicloudgettempfileurlresultitem-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"importObject"
:{
"name"
:
"## importObject(objectName, options?) @importobject"
,
"description"
:
"引用云对象"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| objectName | string | 是 | - | - |
\n
| options | [UniCloudImportObjectOptions](#unicloudimportobjectoptions-values) | 否 | - | - |
\n
#### UniCloudImportObjectOptions 属性值 @unicloudimportobjectoptions-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| customUI | boolean | 否 | - | 是否移除自动展示的ui |
\n
| loadingOptions | [UniCloudImportObjectLoadingOptions](#unicloudimportobjectloadingoptions-values) | 否 | - | loading界面配置 |
\n
| errorOptions | [UniCloudImportObjectErrorOptions](#unicloudimportobjecterroroptions-values) | 否 | - | 错误提示配置 |
\n\n
##### UniCloudImportObjectLoadingOptions 属性值 @unicloudimportobjectloadingoptions-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| title | string | 否 | - | 加载框标题 |
\n
| mask | boolean | 否 | - | 是否移除自动展示的ui |
\n\n
##### UniCloudImportObjectErrorOptions 属性值 @unicloudimportobjecterroroptions-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"onResponse"
:{
"name"
:
"## onResponse(callback) @onresponse"
,
"description"
:
"监听响应事件"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - |
\n
#### UniCloudResponseEvent 属性值 @unicloudresponseevent-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offResponse"
:{
"name"
:
"## offResponse(callback) @offresponse"
,
"description"
:
"移除响应事件监听"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - |
\n
#### UniCloudResponseEvent 属性值 @unicloudresponseevent-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"onRefreshToken"
:{
"name"
:
"## onRefreshToken(callback) @onrefreshtoken"
,
"description"
:
"监听token刷新事件"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - |
\n
#### UniCloudResponseEvent 属性值 @unicloudresponseevent-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offRefreshToken"
:{
"name"
:
"## offRefreshToken(callback) @offrefreshtoken"
,
"description"
:
"移除token刷新事件监听"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| callback | (arg: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - |
\n
#### UniCloudResponseEvent 属性值 @unicloudresponseevent-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"databaseForJQL"
:{
"name"
:
"## databaseForJQL() @databaseforjql"
,
"description"
:
"获取数据库操作实例"
,
"param"
:
""
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :- |
\n
| [Database](#database-values) |
\n\n
#### Database 属性值 @database-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| ctors | Constructor | 是 | - | - |
\n
| _client | any | 是 | - | - |
\n
| collection | (args?: Array
\\
<any
\\
>) => [Collection](#collection-values) | 是 | - | - |
\n
| command | any | 是 | - | - |
\n
| Geo | any | 是 | - | - |
\n\n
##### Collection 属性值 @collection-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| ctors | Constructor | 是 | - | - |
\n
| _client | any | 是 | - | - |
\n
| _collectionList | any | 是 | - | - |
\n
| _stages | any | 是 | - | - |
\n
| where | (condition: any) => [UniCloudDBFilter](#uniclouddbfilter-values) | 是 | - | - |
\n
| doc | (docId: string) => [UniCloudDBFilter](#uniclouddbfilter-values) | 是 | - | - |
\n
| aggregate | () => [UniCloudDBFilter](#uniclouddbfilter-values) | 是 | - | - |
\n
| foreignKey | (foreignKey: string) => [UniCloudDBFilter](#uniclouddbfilter-values) | 是 | - | - |
\n
| add | (data: any) => Promise<[UniCloudDBAddResult](#uniclouddbaddresult-values)> | 是 | - | - |
\n
| get | (arg?: any) => Promise<[UniCloudDBGetResult](#uniclouddbgetresult-values)> | 是 | - | - |
\n
| count | () => Promise<[UniCloudDBCountResult](#uniclouddbcountresult-values)> | 是 | - | - |
\n
| getTemp | () => any | 是 | - | - |
\n
| field | (filed: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| skip | (num: number) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| limit | (num: number) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| orderBy | (order: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n\n
###### UniCloudDBFilter 属性值 @uniclouddbfilter-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| ctors | Constructor | 是 | - | - |
\n
| _client | any | 是 | - | - |
\n
| _stages | any | 是 | - | - |
\n
| get | (arg?: any) => Promise<[UniCloudDBGetResult](#uniclouddbgetresult-values)> | 是 | - | - |
\n
| count | () => Promise<[UniCloudDBCountResult](#uniclouddbcountresult-values)> | 是 | - | - |
\n
| update | (data: any) => Promise<[UniCloudDBUpdateResult](#uniclouddbupdateresult-values)> | 是 | - | - |
\n
| remove | () => Promise<[UniCloudDBRemoveResult](#uniclouddbremoveresult-values)> | 是 | - | - |
\n
| getTemp | () => any | 是 | - | - |
\n
| where | (condition: any) => [UniCloudDBFilter](#uniclouddbfilter-values) | 是 | - | - |
\n
| doc | (docId: string) => [UniCloudDBFilter](#uniclouddbfilter-values) | 是 | - | - |
\n
| field | (filed: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| skip | (num: number) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| limit | (num: number) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| orderBy | (order: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| groupBy | (field: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| groupField | (field: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| distinct | (field: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| geoNear | (options: any) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n\n
###### UniCloudDBGetResult 属性值 @uniclouddbgetresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| data | Array
\\
<any
\\
> | 是 | - | tResult = { /** |
\n
| count | number | 否 | - | SONObject>; /** |
\n
| requestId | string | 否 | - | ber
\\
| null; / |
\n\n
###### UniCloudDBCountResult 属性值 @uniclouddbcountresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| total | number | 是 | - | tResult = { /** |
\n
| requestId | string | 否 | - | al: number; / |
\n\n
###### UniCloudDBUpdateResult 属性值 @uniclouddbupdateresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| updated | number | 是 | - | eResult = { /** |
\n
| requestId | string | 否 | - | ed: number; / |
\n\n
###### UniCloudDBRemoveResult 属性值 @uniclouddbremoveresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| deleted | number | 是 | - | eResult = { /** |
\n
| requestId | string | 否 | - | ed: number; / |
\n\n
###### UniCloudDBQuery 属性值 @uniclouddbquery-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| ctors | Constructor | 是 | - | - |
\n
| _client | any | 是 | - | - |
\n
| _stages | any | 是 | - | - |
\n
| get | (arg?: any) => Promise<[UniCloudDBGetResult](#uniclouddbgetresult-values)> | 是 | - | - |
\n
| count | () => Promise<[UniCloudDBCountResult](#uniclouddbcountresult-values)> | 是 | - | - |
\n
| getTemp | () => any | 是 | - | - |
\n
| field | (filed: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| skip | (num: number) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| limit | (num: number) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| orderBy | (order: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| groupBy | (field: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| groupField | (field: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| distinct | (field: string) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n
| geoNear | (options: any) => [UniCloudDBQuery](#uniclouddbquery-values) | 是 | - | - |
\n\n
###### UniCloudDBAddResult 属性值 @uniclouddbaddresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| id | string | 是 | - | dResult = { /** |
\n
| requestId | string | 否 | - | string; / |
\n
"
,
"compatibility"
:
"### databaseForJQL 兼容性
\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :- | :- | :- | :- | :- | :- |
\n
| 5.0 | √ | 阿里云 3.91，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"getCurrentUserInfo"
:{
"name"
:
"## getCurrentUserInfo() @getcurrentuserinfo"
,
"description"
:
"获取token内缓存的用户信息"
,
"param"
:
""
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :- |
\n
| [UniCloudUserInfo](#uniclouduserinfo-values) |
\n\n
#### UniCloudUserInfo 属性值 @uniclouduserinfo-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| uid | string | 否 | - | serInfo = { / |
\n
| role | Array
\\
<string
\\
> | 是 | - | ing
\\
| null; /** |
\n
| permission | Array
\\
<string
\\
> | 是 | - | ay
\\
<string>; /** |
\n
| tokenExpired | number | 是 | - | ay
\\
<string>; /** |
\n
"
,
"compatibility"
:
"### getCurrentUserInfo 兼容性
\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :- | :- | :- | :- | :- | :- |
\n
| 5.0 | √ | 阿里云 3.9，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"chooseAndUploadFile"
:{
"name"
:
"## chooseAndUploadFile(options) @chooseanduploadfile"
,
"description"
:
"选择并上传文件"
,
"param"
:
"### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) | 是 | - | - |
\n
#### UniCloudChooseAndUploadFileOptions 属性值 @unicloudchooseanduploadfileoptions-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| sourceType | Array
\\
<string
\\
> | 否 | - | - |
\n
| count | number | 否 | - | - |
\n
| sizeType | Array
\\
<string
\\
> | 否 | - | - |
\n
| extension | Array
\\
<string
\\
> | 否 | - | - |
\n
| compressed | boolean | 否 | - | - |
\n
| maxDuration | number | 否 | - | - |
\n
| camera | string | 否 | - | - |
\n
| crop | ChooseImageCropOptions | 否 | - | - |
\n
| type | string | 是 | - | - |
\n
| onChooseFile | (arg: [UniCloudChooseFileResult](#unicloudchoosefileresult-values)) => void | 否 | - | - |
\n
| onUploadProgress | (arg: [UniCloudChooseAndUploadFileProgressEvent](#unicloudchooseanduploadfileprogressevent-values)) => void | 否 | - | - |
\n\n
##### UniCloudChooseFileResult 属性值 @unicloudchoosefileresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| tempFiles | Array
\\
<[UniCloudChooseFileItem](#unicloudchoosefileitem-values)
\\
> | 是 | - | - |
\n
| tempFilePaths | Array
\\
<string
\\
> | 是 | - | - |
\n\n
###### UniCloudChooseFileItem 属性值 @unicloudchoosefileitem-values
\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-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| index | number | 是 | - | - |
\n
| loaded | number | 是 | - | - |
\n
| total | number | 是 | - | - |
\n
| tempFilePath | string | 是 | - | - |
\n
| tempFile | [UniCloudChooseFileItem](#unicloudchoosefileitem-values) | 是 | - | - |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :- |
\n
| Promise<[UniCloudChooseAndUploadFileResult](#unicloudchooseanduploadfileresult-values)> |
\n\n
#### UniCloudChooseAndUploadFileResult 属性值 @unicloudchooseanduploadfileresult-values
\n\n
| 名称 | 类型 | 必备 | 默认值 | 描述 |
\n
| :- | :- | :- | :- | :- |
\n
| tempFiles | Array
\\
<[UniCloudChooseFileItem](#unicloudchoosefileitem-values)
\\
> | 是 | - | - |
\n
| tempFilePaths | Array
\\
<string
\\
> | 是 | - | - |
\n\n
##### UniCloudChooseFileItem 属性值 @unicloudchoosefileitem-values
\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，腾讯云 3.91 | - | √ | x |
\n
"
,
"tutorial"
:
""
}}
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑！
取消
想要评论请
注册
或
登录
