Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
sss宋
unidocs-zh
提交
ff9fb7ca
unidocs-zh
项目概览
sss宋
/
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,发现更多精彩内容 >>
提交
ff9fb7ca
编写于
9月 01, 2023
作者:
G
git_robot
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
更新 utsUnicloudApiJson.json
上级
a3cfa143
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
1 addition
and
1 deletion
+1
-1
docs/.vuepress/utils/utsUnicloudApiJson.json
docs/.vuepress/utils/utsUnicloudApiJson.json
+1
-1
未找到文件。
docs/.vuepress/utils/utsUnicloudApiJson.json
浏览文件 @
ff9fb7ca
{
"uniCloud_props"
:{
"name"
:
"## UniCloud"
,
"description"
:
"new UniCloud(config)"
,
"param"
:
"## 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| config | [UniCloudInitOptions](#unicloudinitoptions) | 是 | - |
\n
### 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"
:
""
},
"Constructor"
:{
"name"
:
"## Constructor(options)"
,
"description"
:
""
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudInitOptions](#unicloudinitoptions) | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
""
,
"tutorial"
:
""
},
"callFunction"
:{
"name"
:
"## callFunction(options)"
,
"description"
:
"请求云函数"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudCallFunctionOptions](#unicloudcallfunctionoptions) | 是 | - |
\n
#### UniCloudCallFunctionOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| name | string | 是 | 云函数名 |
\n
| data | any | 否 | 云函数参数 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| Promise
\\
<T
\\
> |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"uploadFile"
:{
"name"
:
"## uploadFile(options)"
,
"description"
:
"上传文件到云存储"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions) | 是 | - |
\n
#### UniCloudUploadFileOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| filePath | string | 是 | 文件路径 |
\n
| cloudPath | string | 是 | 云端路径 |
\n
| cloudPathAsRealPath | boolean | 否 | 是否以云端路径是否为真实路径保存上传的文件 |
\n
| onUploadProgress | ([UniCloudUploadProgress](#uniclouduploadprogress)) => any | 否 | 上传进度回调 |
\n\n
##### UniCloudUploadProgress
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| loaded | number | 是 | 已上传大小 |
\n
| total | number | 是 | 总大小 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| Promise
\\
<T
\\
> |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"getTempFileURL"
:{
"name"
:
"## getTempFileURL(options)"
,
"description"
:
"获取文件临时URL"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudGetTempFileURLOptions](#unicloudgettempfileurloptions) | 是 | - |
\n
#### UniCloudGetTempFileURLOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| fileList | Array
\\
<string
\\
> | 是 | 文件列表 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| Promise
\\
<T
\\
> |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"importObject"
:{
"name"
:
"## importObject(objectName)"
,
"description"
:
"引用云对象"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| objectName | string | 是 | - |"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| any |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"onResponse"
:{
"name"
:
"## onResponse(callback)"
,
"description"
:
"监听响应事件"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offResponse"
:{
"name"
:
"## offResponse(callback)"
,
"description"
:
"移除响应事件监听"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"onRefreshToken"
:{
"name"
:
"## onRefreshToken(callback)"
,
"description"
:
"监听token刷新事件"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offRefreshToken"
:{
"name"
:
"## offRefreshToken(callback)"
,
"description"
:
"移除token刷新事件监听"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
}}
\ No newline at end of file
{
"uniCloud_props"
:{
"name"
:
"## UniCloud"
,
"description"
:
"new UniCloud(config)"
,
"param"
:
"## 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| config | [UniCloudInitOptions](#unicloudinitoptions) | 是 | - |
\n
### 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"
:
""
},
"Constructor"
:{
"name"
:
"## Constructor(options) @constructor-1"
,
"description"
:
""
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudInitOptions](#unicloudinitoptions) | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
""
,
"tutorial"
:
""
},
"callFunction"
:{
"name"
:
"## callFunction(options) @callfunction"
,
"description"
:
"请求云函数"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudCallFunctionOptions](#unicloudcallfunctionoptions) | 是 | - |
\n
#### UniCloudCallFunctionOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| name | string | 是 | 云函数名 |
\n
| data | any | 否 | 云函数参数 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| Promise
\\
<T
\\
> |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"uploadFile"
:{
"name"
:
"## uploadFile(options) @uploadfile"
,
"description"
:
"上传文件到云存储"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions) | 是 | - |
\n
#### UniCloudUploadFileOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| filePath | string | 是 | 文件路径 |
\n
| cloudPath | string | 是 | 云端路径 |
\n
| cloudPathAsRealPath | boolean | 否 | 是否以云端路径是否为真实路径保存上传的文件 |
\n
| onUploadProgress | ([UniCloudUploadProgress](#uniclouduploadprogress)) => any | 否 | 上传进度回调 |
\n\n
##### UniCloudUploadProgress
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| loaded | number | 是 | 已上传大小 |
\n
| total | number | 是 | 总大小 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| Promise
\\
<T
\\
> |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"getTempFileURL"
:{
"name"
:
"## getTempFileURL(options) @gettempfileurl"
,
"description"
:
"获取文件临时URL"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| options | [UniCloudGetTempFileURLOptions](#unicloudgettempfileurloptions) | 是 | - |
\n
#### UniCloudGetTempFileURLOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| fileList | Array
\\
<string
\\
> | 是 | 文件列表 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| Promise
\\
<T
\\
> |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 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
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| customUI | boolean | 否 | 是否移除自动展示的ui |
\n
| loadingOptions | [UniCloudImportObjectLoadingOptions](#unicloudimportobjectloadingoptions) | 否 | loading界面配置 |
\n
| errorOptions | [UniCloudImportObjectErrorOptions](#unicloudimportobjecterroroptions) | 否 | 错误提示配置 |
\n\n
##### UniCloudImportObjectLoadingOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| title | string | 否 | 加载框标题 |
\n
| mask | boolean | 否 | 加载框是否显示mask |
\n\n
##### UniCloudImportObjectErrorOptions
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| type | string | 否 | 错误提示类型,可以是modal或者toast |
\n
| retry | boolean | 否 | 是否显示重试按钮 |
\n
"
,
"returnValue"
:
"### 返回值
\n\n
| 类型 |
\n
| :-|
\n
| any |
\n
"
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"onResponse"
:{
"name"
:
"## onResponse(callback) @onresponse"
,
"description"
:
"监听响应事件"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offResponse"
:{
"name"
:
"## offResponse(callback) @offresponse"
,
"description"
:
"移除响应事件监听"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"onRefreshToken"
:{
"name"
:
"## onRefreshToken(callback) @onrefreshtoken"
,
"description"
:
"监听token刷新事件"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | x |
\n
"
,
"tutorial"
:
""
},
"offRefreshToken"
:{
"name"
:
"## offRefreshToken(callback) @offrefreshtoken"
,
"description"
:
"移除token刷新事件监听"
,
"param"
:
"### 参数
\n\n
| 参数名 | 参数类型 | 是否必填 | 描述 |
\n
| :-| :-| :-| :-|
\n
| callback | (any?) => any | 是 | - |"
,
"returnValue"
:
""
,
"compatibility"
:
"### 兼容性
\n\n
| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
\n
| :-| :-| :-| :-| :-| :-|
\n
| 4.4 | √ | 3.9.0 仅支持阿里云 | - | √ | 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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录