API | 操作名 | 操作描述 |
简单上传对象 | 上传一个对象至存储桶 |
API | 操作名 | 操作描述 |
查询分块上传 | 查询正在进行中的分块上传信息 | |
初始化分块上传 | 初始化分块上传操作 | |
上传分块 | 分块上传对象 | |
查询已上传块 | 查询特定分块上传操作中的已上传的块 | |
完成分块上传 | 完成整个文件的分块上传 | |
终止分块上传 | 终止一个分块上传操作并删除已上传的块 |
// 存储桶所在地域简称,例如广州地区是 ap-guangzhoulet region = "COS_REGION";// 创建 CosXmlServiceConfig 对象,根据需要修改默认的配置参数let serviceConfig = {region: region,isDebuggable: true,isHttps: true,};// 创建 TransferConfig 对象,根据需要修改默认的配置参数// TransferConfig 可以设置智能分块阈值 默认对大于或等于2M的文件自动进行分块上传,可以通过如下代码修改分块阈值let transferConfig = {forceSimpleUpload: false,enableVerification: true,divisionForUpload: 2097152, // 设置大于等于 2M 的文件进行分块上传sliceSizeForUpload: 1048576, //设置默认分块大小为 1M};// 注册默认 COS TransferMangerawait Cos.registerDefaultTransferManger(serviceConfig, transferConfig);// 获取 CosTransferMangerlet cosTransferManger: CosTransferManger = Cos.getDefaultTransferManger();//let cosTransferManger: CosTransferManger = Cos.getTransferManger(newRegion);// 存储桶名称,由 bucketname-appid 组成,appid 必须填入,可以在 COS 控制台查看存储桶名称。 https://console.tencentcloud.com/cos5/bucketlet bucket = "examplebucket-1250000000";let cosPath = "exampleobject"; //对象在存储桶中的位置标识符,即称对象键let srcPath = "本地文件的路径"; //本地文件的路径//若存在初始化分块上传的 UploadId,则赋值对应的 uploadId 值用于续传;否则,赋值 undefinedlet _uploadId = undefined;// 上传成功回调let successCallBack = (header?: object) => {// todo 上传成功后的逻辑};//上传失败回调let failCallBack = (clientError?: CosXmlClientError, serviceError?: CosXmlServiceError) => {// todo 上传失败后的逻辑if (clientError) {console.log(clientError);}if (serviceError) {console.log(serviceError);}};//上传状态回调, 可以查看任务过程let stateCallBack = (state: TransferState) => {// todo notify transfer state};//上传进度回调let progressCallBack = (complete: number, target: number) => {// todo Do something to update progress...};//初始化分块完成回调let initMultipleUploadCallBack = (bucket: string, cosKey: string, uploadId: string) => {//用于下次续传上传的 uploadId_uploadId = uploadId;};//开始上传let transferTask:TransferTask = await cosTransferManger.upload(bucket,cosPath,srcPath,{uploadId: _uploadId,resultListener: {successCallBack: successCallBack,failCallBack: failCallBack},stateCallback: stateCallBack,progressCallback: progressCallBack,initMultipleUploadCallback: initMultipleUploadCallBack,});//暂停任务transferTask.pause();//恢复任务transferTask.resume();//取消任务transferTask.cancel();
参数名称 | 描述 | 类型 | 默认值 | 支持平台 |
divisionForUpload | 设置启用分块上传的最小对象大小 | Int | 2097152 | Android和iOS |
sliceSizeForUpload | 设置分块上传时的分块大小 | Int | 1048576 | Android和iOS |
enableVerification | 分片上传时是否整体校验 | Bool | true | Android和iOS |
forceSimpleUpload | 是否强制使用简单上传 | Bool | false | Android |
参数名称 | 描述 | 类型 | 是否必选 |
bucket | 桶名称,Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述 | String | 是 |
cosPath | 对象键 是对象在存储桶中的唯一标识。例如,在对象的访问域名 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/picture.jpg 中,对象键为 doc/picture.jpg | String | 是 |
fileUri | 需要上传的本地文件路径 | String | 是 |
uploadId | 若存在初始化分块上传的 UploadId,则赋值对应的 uploadId 值用于续传 | String | 否 |
stroageClass | 存储类型 | String | 否 |
trafficLimit | 单链接限速(限速值设置范围为 819200 - 838860800,单位为 bit/s,即100KB/s - 100MB/s) | Int | 否 |
ResultListener | 上传结果回调(包括成功回调和失败回调) | ResultListener | 否 |
StateCallBack | 上传状态回调 | StateCallBack | 否 |
ProgressCallBack | 上传进度回调 | ProgressCallBack | 否 |
InitMultipleUploadCallback | 初始化分块完成回调 | InitMultipleUploadCallback | 否 |
本页内容是否解决了您的问题?