收藏

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

我的收藏

简介

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

收藏文件/目录

功能说明

用于收藏文件/目录。

示例代码

try{
let result = await SMHFavoriteApis.favorite({
libraryId:"libraryId",
spaceId:"spaceId",
path:'path'
});
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,获取请参见 创建租户空间
String
inode
文件目录ID,可以为文件或者目录
String
path
文件目录路径,与 inode 参数二选一,如果同时指定 inode 和 path,则以 inode 为准
String

查看指定空间收藏列表

功能说明

用于查看指定空间收藏列表。

示例代码

try{
let result = await SMHFavoriteApis.listFavorite({
libraryId:"libraryId",
spaceId:"spaceId",
orderBy:SMHFileListOrderBy.favoriteTime,
orderByType:SMHOrderByType.asc,
limit:"5"
});
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,获取请参见 创建租户空间
String
marker
用于顺序列出分页的标识
String
limit
用于顺序列出分页时本地列出的项目数限制,默认为20
String
page
分页码,默认第一页,可选参数,不能与 marker 和 limit 参数同时使用
Number
pageSize
分页大小,默认 20,可选参数,不能与 marker 和 limit 参数同时使用
Number
orderBy
排序字段,按收藏时间排序为 favoriteTime(默认),目前仅支持按收藏时间排序
SMHFileListOrderBy
orderByType
排序方式,升序为 asc,降序为 desc
SMHOrderByType
withPath
是否返回 path,返回为 true,不返回为 false(默认)
Bool

删除指定空间收藏

功能说明

用于删除指定空间收藏。

示例代码

try{
let result = await SMHFavoriteApis.cancelFavorite({
libraryId:"libraryId",
spaceId:"spaceId",
path:'path'
});
}catch(e){
// 异常处理
}

参数说明

请求参数
描述
类型
是否必选
libraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
spaceId
空间 ID,获取请参见 创建租户空间
String
inode
文件目录ID,可以为文件或者目录
String
path
文件目录路径,与 inode 参数二选一,如果同时指定 inode 和 path,则以 inode 为准
String