Tencent Cos

Title: tencentCos Description: 模块封装了腾讯云对象存储服务COS /

来自于：厦门软云网络科技有限公司

init

uploadObject

cancelUpload

downloadObject

deleteObject

论坛示例

该论坛提供了模块使用和问题反馈的入口，你可以在论坛中找到使用的Demo，以及问题反馈

概述

该模块可以将图片、视频、文件等资源等各种类型的文件存储到腾讯云存储，可以实现上传资源文件到云存储的操作，同时上传文件会自动根据文件大小是否使用分片上传。

获取配置信息

注册或登录腾讯云账号，并开通COS存储

  • 获取配置信息

点击秘钥管理，获取一下配置

参数 含义
appId 应用的Id
secretId 加密Id
secretKey 加密Key
  • 获取存储通信息

存储桶列表，选择要使用的存储桶，获取一下信息

参数 含义
bucket 存储桶的名称
region 所属区域

技术支持

  • 如果您需要跑通测试的Demo；
  • 如果希望获取内测功能和高级参数
  • 或者您有什么意见建议反馈，都可以联系我们的技术支持；

技术支持客服微信为: ruanyunkeji001或ruanyunkeji002

模块接口

init

初始化IM

init({params}, function(ret, err))

params

appId:

  • 类型: 字符串类型
  • 描述: (必填项)应用的Id

secretId:

  • 类型: 字符串类型
  • 描述: (必填项)加密Id

secretKey:

  • 类型: 字符串类型
  • 描述: (必填项)加密Key

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true
}
  • 字段描述: status:
    • 类型: 布尔类型
    • 描述: 初始化是否成功; true表示操作成功

代码示例

cos.init({
    appId: '125xxxx911',
    secretId: 'AKIDcNxxxxxTlmwtdrn22',
    secretKey: 'CBuNluxxxxqQj35pW8Zk',
    regionName: 'ap-guangzhou'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

uploadObject

上传对象

uploadObject({param}, function(ret, err))

params

bucket:

  • 类型: 字符串类型
  • 描述: (必填项)要上传的存储桶

key:

  • 类型: 字符串类型
  • 描述: (必填项)键名

path:

  • 类型: 字符串类型
  • 描述: (必填项)上传文件的路径

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    eventType: "onConnectSuccess",
    code: -1,
    msg: "错误信息",
    info: {
        ...
    }
}

  • 字段详情:

    status:

    • 类型: 布尔类型

    • 描述: 操作是否成功; true表示操作成功

      eventType:

    • 类型: 字符串类型
    • 描述: 上传进度事件回调

    • 取值范围: onProgress

      key:

    • 类型: 字符串类型

    • 描述: 正在上传的键

      currentSize:

    • 类型: 整数类型

    • 描述: 已上传大小

      totalSize:

    • 类型: 整数类型
    • 描述: 总大小

err:

  • 类型: JSON对象
  • 内部字段
{
    code: 110, 
    msg: 'bucket、key和path参数为必填'
}

  • 字段详情:

    code:

    • 类型: 整数类型

    • 描述: 错误码

      msg：

    • 类型: 整数类型
    • 描述: 错误信息

示例代码

cos.uploadObject({
    bucket: 'examplexxxx-xxx49911',
    key: 'test01',
    path: '/library/xxxx'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

cancelUpload

取消上传

cancelUpload({params}, function(ret, err))

params

bucket:

  • 类型: 字符串类型
  • 描述: (必填项)要上传的存储桶

key:

  • 类型: 字符串类型
  • 描述: (必填项)键名

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    eventType: "onConnectSuccess",
    code: -1,
    msg: "错误信息",
    info: {
        ...
    }
}

  • 字段详情:

    status:

    • 类型: 布尔类型

    • 描述: 操作是否成功; true表示操作成功

      key：

    • 类型: 字符串类型
    • 描述: 取消上传的键值

err:

  • 类型: JSON对象
  • 内部字段
{
    code: 110, 
    msg: 'bucket、key和path参数为必填'
}

  • 字段详情:

    code:

    • 类型: 整数类型

    • 描述: 错误码

      msg：

    • 类型: 整数类型
    • 描述: 错误信息

示例代码

cos.cancelUpload({
    bucket: 'examplexxxx-xxx49911',
    key: 'test01'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringiy(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

downloadObject

下载对象

downloadObject({params}, function(ret, err))

params

bucket:

  • 类型: 字符串类型
  • 描述: (必填项)要上传的存储桶

key:

  • 类型: 字符串类型
  • 描述: (必填项)键名

path:

  • 类型: 字符串类型
  • 描述: (必填项)指定下载的文件路径

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true,
    eventType: "onProgress",
    key: "test001"
    currentSize: 12342,
    totalSize: 134212
    path: 'xxxx'
}

  • 字段详情:

    status:

    • 类型: 布尔类型

    • 描述: 操作是否成功; true表示操作成功

      eventType:

    • 类型: 字符串类型
    • 描述: 上传进度事件回调

    • 取值范围: onProgress

      key:

    • 类型: 字符串类型

    • 描述: 正在上传的键

      currentSize:

    • 类型: 整数类型

    • 描述: 已上传大小

      totalSize:

    • 类型: 整数类型

    • 描述: 总大小

      path:

    • 类型: 字符串类型
    • 描述: 下载的文件路径

err:

  • 类型: JSON对象
  • 内部字段
{
    code: 110, 
    msg: 'bucket、key和path参数为必填'
}

  • 字段详情:

    code:

    • 类型: 整数类型

    • 描述: 错误码

      msg：

    • 类型: 整数类型
    • 描述: 错误信息

示例代码

cos.downloadObject({
    bucket: 'examplexxxx-xxx49911',
    key: 'test01',
    path: 'widget://download/test01'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

deleteObject

删除单个对象

deleteObject({params}, function(ret, err))

params

bucket:

  • 类型: 字符串类型
  • 描述: (必填项)要上传的存储桶

key:

  • 类型: 字符串类型
  • 描述: (必填项)键名

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 
}

  • 字段详情:

    status:

    • 类型: 布尔类型
    • 描述: true表示操作成功

err:

  • 类型: JSON对象
  • 内部字段
{
    code: 110, 
    msg: 'bucket、key和path参数为必填'
}

  • 字段详情:

    code:

    • 类型: 整数类型

    • 描述: 错误码

      msg：

    • 类型: 整数类型
    • 描述: 错误信息

示例代码

cos.deleteObject({
    bucket: 'examplexxxx-xxx49911',
    key: 'test01',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供1.0.0及更高版本

更多功能

如果您需要高级参数或者内测功能，请联系我们的技术客服: ruanyunkeji001或者ruanyunkeji002

  • 获取文件信息(内测)
  • 批量删除(内测)
  • 文件列表(内测)