Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
uni-app
提交
ef2ecf67
U
uni-app
项目概览
DCloud
/
uni-app
30 天 前同步成功
通知
702
Star
38704
Fork
3642
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
7
列表
看板
标记
里程碑
合并请求
1
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
uni-app
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
7
Issue
7
列表
看板
标记
里程碑
合并请求
1
合并请求
1
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
ef2ecf67
编写于
6月 16, 2020
作者:
雪洛
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: uniCloud storage tips
上级
bb12fca1
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
1 addition
and
184 deletion
+1
-184
docs/uniCloud/cf-storage.md
docs/uniCloud/cf-storage.md
+0
-137
docs/uniCloud/storage.md
docs/uniCloud/storage.md
+1
-47
未找到文件。
docs/uniCloud/cf-storage.md
已删除
100644 → 0
浏览文件 @
bb12fca1
## uniCloud.uploadFile(Object uploadFileOptions)
上传文件至云开发存储服务。
**目前仅腾讯云支持此接口**
**uploadFileOptions参数说明**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| cloudPath | string | 是 | 文件的绝对路径,包含文件名。例如 foo/bar.jpg、foo/bar/baz.jpg 等。 |
| fileContent | fs.ReadStream | 是 | buffer或要上传的文件
[
可读流
](
https://nodejs.org/api/stream.html#stream_class_stream_readable
)
。 |
**响应参数**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string| 否 | 状态码,操作成功则不返回。 |
| message | string| 否 | 错误描述。 |
| fileID | fileID| 是 | 文件唯一 ID,用来访问文件,建议存储起来。 |
| requestId | string| 否 | 请求序列号,用于错误排查。 |
**示例代码**
```
javascript
const
fs
=
require
(
"
fs
"
);
let
result
=
await
uniCloud
.
uploadFile
({
cloudPath
:
"
test-admin.jpeg
"
,
fileContent
:
fs
.
createReadStream
(
`
${
__dirname
}
/cos.jpeg`
)
});
```
## uniCloud.getTempFileURL(Object getTempFileURLOptions)
获取文件下载链接,
**目前仅腾讯云支持**
**getTempFileURLOptions参数说明**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| fileList|
<
Array
>
.string| 是 | 要下载的文件 ID 组成的数组。|
**fileList字段**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| fileID| string | 是 | 文件 ID。 |
| maxAge| Integer | 是 | 文件链接有效期。|
**响应参数**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string | 否 | 状态码,操作成功则为 SUCCESS。|
| message | string | 否 | 错误描述。 |
| fileList |
<
Array
>
.object| 否 | 存储下载链接的数组。 |
| requestId | string | 否 | 请求序列号,用于错误排查。 |
**fileList字段**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string| 否 | 删除结果,成功为 SUCCESS。|
| fileID | string| 是 | 文件 ID。 |
| tempFileURL | string| 是 | 文件访问链接。 |
**示例代码**
```
javascript
let
result
=
await
uniCloud
.
getTempFileURL
({
fileList
:
[
'
cloud://test-28farb/a.png
'
]
});
```
## uniCloud.deleteFile(Object deleteFileOptions)
删除云端文件。
**deleteFileOptions参数说明**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| fileList|
<
Array
>
.string| 是 | 要删除的文件 ID 组成的数组。|
**响应参数**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string | 否 | 状态码,操作成功则不返回。|
| message | string | 否 | 错误描述 |
| fileList |
<
Array
>
.object| 否 | 删除结果组成的数组。 |
| requestId | string | 否 | 请求序列号,用于错误排查。|
**fileList字段**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | string | 否 | 删除结果,成功为SUCCESS。 |
| fileID | string | 是 | 文件 ID。 |
**示例代码**
```
javascript
let
result
=
await
uniCloud
.
deleteFile
({
fileList
:
[
"
cloud://test-28farb/a.png
"
]
});
```
## uniCloud.downloadFile(Object downloadFileOptions)
下载已上传至云开发的文件至本地(默认本地根目录/root)。
**downloadFileOptions参数说明**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| fileID | string| 是 | 要下载的文件的 ID。 |
| tempFilePath| string| 否 | 下载的文件要存储的位置。|
**响应参数**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string| 否 | 状态码,操作成功则不返回。 |
| message | string| 否 | 错误描述。 |
| fileContent | Buffer| 否 | 下载的文件的内容。如果传入 tempFilePath 则不返回该字段。|
| requestId | string| 否 | 请求序列号,用于错误排查。 |
**示例代码**
```
javascript
let
result
=
await
uniCloud
.
downloadFile
({
fileID
:
"
cloud://aa-99j9f/my-photo.png
"
,
// tempFilePath: '/tmp/test/storage/my-photo.png'
});
```
\ No newline at end of file
docs/uniCloud/storage.md
浏览文件 @
ef2ecf67
...
...
@@ -49,8 +49,6 @@
|字段 |类型 |说明 |
|:-: |:-: |:-: |
|code |String |状态码,操作成功则不返回 |
|message |String |错误描述 |
|fileID |String |文件唯一 ID,用来访问文件,建议存储起来 |
|requestId |String |请求序列号,用于错误排查 |
...
...
@@ -174,7 +172,7 @@ uniCloud.getTempFileURL({
## deleteFile(Object object)
删除云端文件
删除云端文件
,
**使用阿里云作为服务商时,最好不要使用客户端删除云端文件**
#### 请求参数
...
...
@@ -188,8 +186,6 @@ uniCloud.getTempFileURL({
|字段 |类型 |必填 |说明 |
|:-: |:-: |:-: |:-: |
|code |String |否 |状态码,操作成功则不返回 |
|message |String |否 |错误描述 |
|fileList |
<
Array
>
.Object |否 |删除结果组成的数组 |
|requestId |String |否 |请求序列号,用于错误排查 |
...
...
@@ -197,7 +193,6 @@ uniCloud.getTempFileURL({
|字段 |类型 |必填 |说明 |
|:-: |:-: |:-: |:-: |
|code |String |否 |删除结果,成功为 SUCCESS |
|fileID |String |是 |文件 ID |
#### 示例代码
...
...
@@ -221,37 +216,6 @@ uniCloud.deleteFile(
);
```
<!-- ### 下载文件
downloadFile(Object)
请求参数
| 字段 | 类型 | 必填 | 说明
| :-: | :-: | :-: | :-: |
| fileID | String | 是 | 要下载的文件的id
| tempFilePath | String | 否 | 下载的文件要存储的位置
响应参数
| 字段 | 类型 | 必填 | 说明
| :-: | :-: | :-: | :-: |
| code | String | 否 | 状态码,操作成功则不返回
| message | String | 否 | 错误描述
| fileContent | Buffer | 否 | 下载的文件的内容。如果传入tempFilePath则不返回该字段
| requestId | String | 否 | 请求序列号,用于错误排查
示例代码
```
javascript
let
result
=
await
tcb
.
downloadFile
({
fileID
:
"
cloud://aa-99j9f/my-photo.png
"
,
// tempFilePath: '/tmp/test/storage/my-photo.png',
success
(){},
fail
(){},
complete
(){}
});
```
-->
# 云函数API
## uniCloud.uploadFile(Object uploadFileOptions)
...
...
@@ -276,8 +240,6 @@ let result = await tcb.downloadFile({
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string| 否 | 状态码,操作成功则不返回。 |
| message | string| 否 | 错误描述。 |
| fileID | fileID| 是 | 文件唯一 ID,用来访问文件,建议存储起来。 |
| requestId | string| 否 | 请求序列号,用于错误排查。 |
...
...
@@ -321,8 +283,6 @@ let result = await uniCloud.uploadFile({
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string | 否 | 状态码,操作成功则为 SUCCESS。|
| message | string | 否 | 错误描述。 |
| fileList |
<
Array
>
.object| 否 | 存储下载链接的数组。 |
| requestId | string | 否 | 请求序列号,用于错误排查。 |
...
...
@@ -330,7 +290,6 @@ let result = await uniCloud.uploadFile({
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string| 否 | 删除结果,成功为 SUCCESS。|
| fileID | string| 是 | 文件 ID。 |
| tempFileURL | string| 是 | 文件访问链接。 |
...
...
@@ -358,8 +317,6 @@ let result = await uniCloud.getTempFileURL({
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string | 否 | 状态码,操作成功则不返回。|
| message | string | 否 | 错误描述 |
| fileList |
<
Array
>
.object| 否 | 删除结果组成的数组。 |
| requestId | string | 否 | 请求序列号,用于错误排查。|
...
...
@@ -367,7 +324,6 @@ let result = await uniCloud.getTempFileURL({
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | string | 否 | 删除结果,成功为SUCCESS。 |
| fileID | string | 是 | 文件 ID。 |
#### 示例代码
...
...
@@ -403,8 +359,6 @@ let result = await uniCloud.deleteFile({
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code | string| 否 | 状态码,操作成功则不返回。 |
| message | string| 否 | 错误描述。 |
| fileContent | Buffer| 否 | 下载的文件的内容。如果传入 tempFilePath 则不返回该字段。|
| requestId | string| 否 | 请求序列号,用于错误排查。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录