文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>智能媒资托管>SDK 文档>鸿蒙 SDK>回收站

回收站

最近更新时间：2025-09-29 11:21:32

我的收藏

本页目录：

简介

本文档提供关于回收站相关接口介绍以及示例代码。

列出回收站项目

功能说明

用于列出回收站项目。

示例代码

try{
    let result = await SMHRecycledApis.listRecycled({
        libraryId:"libraryId",
        spaceId:"spaceId"
    })
}catch (e) {
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否
marker
用于顺序列出分页的标识，不能与 page 和 page_size 参数同时使用
String
否
limit
用于顺序列出分页时本地列出的项目数限制，不能与 page 和 page_size 参数同时使用
String
否
page
分页码，默认第一页，可选参数，不能与 marker 和 limit 参数同时使用
Number
否
pageSize
分页大小，默认 20，可选参数，不能与 marker 和 limit 参数同时使用
Number
否
orderBy
排序字段，按名称排序为 name，按修改时间排序为 modificationTime，按文件大小排序为 size，按删除时间排序为 removalTime，按剩余时间排序为 remainingTime
SMHFileListOrderBy
否
orderByType
排序方式，升序为 asc，降序为 desc
SMHOrderByType
否

恢复指定回收站项目

功能说明

恢复指定回收站项目。

示例代码

try{
    let result = await SMHRecycledApis.restoreRecycledObject({
        libraryId:"libraryId",
        spaceId:"spaceId",
        recycledItemId:312
    })
}catch(e){
// 异常处理
}


参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否
recycledItemId
回收站项目 ID
Number
是
conflictResolutionStrategy
路径冲突时的处理方式，默认为 ask
ask: 冲突时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码
rename: 冲突时自动重命名文件
overwrite: 如果冲突目标为目录时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码，否则覆盖已有文件
SMHConflictResolutionStrategy
否
restorePathStrategy
恢复项目源路径的处理方式，默认为 originalPath
originalPath:恢复到原始路径，原始路径不存在则报错
fallbackToRoot:恢复到原始路径，原始路径不存在则恢复到根目录
SMHRestorePathStrategy
否

批量恢复指定回收站项目

功能说明

用于批量恢复指定回收站项目。

示例代码

try{
    let result = await SMHRecycledApis.batchRestoreRecycledObject({
        libraryId:"libraryId",
        spaceId:"spaceId",
        restorePathStrategy:SMHRestorePathStrategy.fallbackToRoot,
        recycledItemIds:[1,2,3,4]
    })
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否
recycledItemIds
批量恢复的 recycledItemId 集合
Number数组
是
restorePathStrategy
恢复项目源路径的处理方式，默认为 originalPath
originalPath:恢复到原始路径，原始路径不存在则报错
fallbackToRoot:恢复到原始路径，原始路径不存在则恢复到根目录
SMHRestorePathStrategy
否

删除指定回收站项目

功能说明

用于删除指定回收站项目。

示例代码

try{
    let result = await SMHRecycledApis.deleteRecycledObject({
        libraryId:"libraryId",
        spaceId:"spaceId",
        recycledItemId:312
    })
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否
recycledItemId
回收站项目 ID
Number
是

批量删除指定回收站项目

功能说明

用于批量删除指定回收站项目。

示例代码

try{
  let result = await SMHRecycledApis.batchDeleteRecycledObject({
    libraryId:"libraryId",
    spaceId:"spaceId",
    recycledItemIds:[1,2,3,4]
   })
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否
recycledItemIds
批量删除的 recycledItemId 集合
Number数组
是

清空回收站

功能说明

用于清空回收站。

示例代码

try{
  let result = await SMHRecycledApis.clearRecycled({
      libraryId:"libraryId",
      spaceId:"spaceId"
  })
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否

查看回收站文件详情

功能说明

用于查看回收站文件详情。

示例代码

try{
  let reuslt = await SMHRecycledApis.fileDetail({
      libraryId:"libraryId",
      spaceId:"spaceId",
      recycledItemId:312
  })
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否
recycledItemId
回收站项目 ID
Number
是

预览回收站项目

功能说明

用于根据文件 ID 查询文件信息。

示例代码

try{
  let reuslt = await SMHRecycledApis.preview({
      libraryId:"libraryId",
      spaceId:"spaceId",
      recycledItemId:312
  })
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间
String
否
recycledItemId
回收站项目 ID
Number
是
type
文档类型文件的预览方式，如果设置为"pic"则以JPG格式预览文档首页，否则以HTML格式预览文档
SMHPreviewType
否
size
图片或视频封面的缩放大小，相关说明参阅接口说明
String
否
scale
图片或视频封面的等比例缩放百分比，不传 Size 时生效
String
否
widthSize
图片或视频封面的缩放宽度，不传高度时，高度按等比例缩放，不传 Size 和 Scale 时生效
String
否
heightSize
图片或视频封面的缩放高度，不传宽度时，宽度按等比例缩放，不传 Size 和 Scale 时生效
String
否
frameNumber
GIF 文件的帧数，针对 GIF 的降帧处理，仅在预览 GIF 类型文件时生效
String
否
中国站
目录