智能媒资托管搜索

简介
本文档提供关于搜索相关接口介绍以及示例代码。
搜索目录与文件
功能说明
用于搜索目录与文件。
示例代码
try{
  let result = await SMHSearchApis.initSearchTask({
      libraryId:"libraryId",
      spaceId:"spaceId",
      keyword:"1"
  });
}catch(e){
// 异常处理
}
﻿
参数说明
请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库﻿
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间﻿
String
否
keyword
搜索关键字，可使用空格分隔多个关键字，关键字之间为“或”的关系并优先展示匹配关键字较多的项目
String
否
scope
搜索范围，指定搜索的目录，可选参数，如搜索根目录可指定为空字符串、“/”或不指定该字段
String
否
extname
搜索文件后缀
String 数组
否
type
搜索类型，可反选（!）。当前支持的类型包括：
all：搜索所有类型文件和文件夹，当不传 type 或传空时默认为 all，反选时传 !all
dir：仅搜索目录，不搜索文件，反选时传 !dir
file：仅搜索所有类型文件，不搜索目录，反选时传 !file
doc、xls 或 ppt：仅搜索 Word、Excel 或 PowerPoint 类型文档，对应的文件扩展名为 .doc(x)、.xls(x) 或 .ppt(x)，反选时传 !doc、!xls 或 !ppt
pdf 或 txt：仅搜索 PDF 或纯文本类型文档，对应的文件扩展名为 .pdf 或 .txt，支持反选，反选时传 !pdf 或 !txt
image、video 或 audio: 仅搜索图片、视频或音频类型文件，对应的文件 MIME（Content Type）分别为 image/、video/ 或 audio/*，反选时传 !image、!video 或 !audio
PowerPoint：仅搜索演示文稿，如 .ppt、.pptx、.pot、.potx 等，反选时传 !powerpoint
excel：仅搜索表格文件，如 .xls、.xlsx、.ett、.xltx、.csv 等，反选时传 !excel
word：仅搜索文档，如 .doc、.docx、.dot、.wps、.wpt 等，反选时传 !word
text：仅搜索纯文本，如 .txt、.asp、.htm 等，反选时传 !text
SMHFileInfoSelectType 数组
否
minFileSize
搜索文件大小范围（最小），单位 Byte
Number
否
maxFileSize
搜索文件大小范围（最大），单位 Byte
Number
否
modificationTimeStart
搜索更新时间范围（起始），与时区无关
﻿
否
modificationTimeEnd
搜索更新时间范围（结束），与时区无关
﻿
否
orderBy
排序字段，当前支持按名称、修改时间、文件大小、创建时间排序具体类型如下：
name：按名称排序
modificationTime：按修改时间排序
size：按文件大小排序
creationTime：按创建时间排序
localCreationTime：按照文件对应的本地创建时间排序
localModificationTime：按照文件对应的本地修改时间排序
SMHFileListOrderBy
否
orderByType
排序方式，升序为 asc，降序为 desc
SMHOrderByType
否
searchMode
搜索方式，快速为 fast，普通为 normal，默认 normal
SMHSearchMode
否
labels
搜索文件标签
String数组
否
categories
搜索文件自定义分类信息
String数组
否
withInode
上传完是否返回 inode，即文件目录 ID
Bool
否
withFavoriteStatus
是否返回收藏状态
Bool
否
继续获取搜索结果
功能说明
用于继续获取搜索结果。
示例代码
try{
  let result = await SMHSearchApis.resumeSearchTask({
      libraryId:"libraryId",
      spaceId:"spaceId",
      searchId:"searchId",
      marker:"marker"
  });
}catch(e){
// 异常处理
}
参数说明
请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库﻿
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间﻿
String
否
searchId
搜索任务 ID
String
是
marker
分页标识，创建搜索任务时或继续获取搜索结果时返回的 nextMarker 字段，必选参数
String
是
withInode
上传完是否返回 inode，即文件目录 ID
Bool
否
withFavoriteStatus
是否返回收藏状态
Bool
否
删除搜索任务
功能说明
用于删除搜索任务。
示例代码
try{
  let result = await SMHSearchApis.deleteSearchTask({
      libraryId:"libraryId",
      spaceId:"spaceId",
      searchId:"searchId"
  });
}catch(e){
// 异常处理
}
参数说明
请求参数
描述
类型
是否必选
libraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库﻿
String
是
spaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见 创建租户空间﻿
String
否
searchId
搜索任务 ID
String
是

请求参数	描述	类型	是否必选
libraryId	媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见创建媒体库	String	是
spaceId	空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则必须指定该参数，获取请参见创建租户空间	String	否
keyword	搜索关键字，可使用空格分隔多个关键字，关键字之间为“或”的关系并优先展示匹配关键字较多的项目	String	否
scope	搜索范围，指定搜索的目录，可选参数，如搜索根目录可指定为空字符串、“/”或不指定该字段	String	否
extname	搜索文件后缀	String 数组	否
type	搜索类型，可反选（!）。当前支持的类型包括： all：搜索所有类型文件和文件夹，当不传 type 或传空时默认为 all，反选时传 !all dir：仅搜索目录，不搜索文件，反选时传 !dir file：仅搜索所有类型文件，不搜索目录，反选时传 !file doc、xls 或 ppt：仅搜索 Word、Excel 或 PowerPoint 类型文档，对应的文件扩展名为 .doc(x)、.xls(x) 或 .ppt(x)，反选时传 !doc、!xls 或 !ppt pdf 或 txt：仅搜索 PDF 或纯文本类型文档，对应的文件扩展名为 .pdf 或 .txt，支持反选，反选时传 !pdf 或 !txt image、video 或 audio: 仅搜索图片、视频或音频类型文件，对应的文件 MIME（Content Type）分别为 image/、video/ 或 audio/*，反选时传 !image、!video 或 !audio PowerPoint：仅搜索演示文稿，如 .ppt、.pptx、.pot、.potx 等，反选时传 !powerpoint excel：仅搜索表格文件，如 .xls、.xlsx、.ett、.xltx、.csv 等，反选时传 !excel word：仅搜索文档，如 .doc、.docx、.dot、.wps、.wpt 等，反选时传 !word text：仅搜索纯文本，如 .txt、.asp、.htm 等，反选时传 !text	SMHFileInfoSelectType 数组	否
minFileSize	搜索文件大小范围（最小），单位 Byte	Number	否
maxFileSize	搜索文件大小范围（最大），单位 Byte	Number	否
modificationTimeStart	搜索更新时间范围（起始），与时区无关		否
modificationTimeEnd	搜索更新时间范围（结束），与时区无关		否
orderBy	排序字段，当前支持按名称、修改时间、文件大小、创建时间排序具体类型如下： name：按名称排序 modificationTime：按修改时间排序 size：按文件大小排序 creationTime：按创建时间排序 localCreationTime：按照文件对应的本地创建时间排序 localModificationTime：按照文件对应的本地修改时间排序	SMHFileListOrderBy	否
orderByType	排序方式，升序为 asc，降序为 desc	SMHOrderByType	否
searchMode	搜索方式，快速为 fast，普通为 normal，默认 normal	SMHSearchMode	否
labels	搜索文件标签	String数组	否
categories	搜索文件自定义分类信息	String数组	否
withInode	上传完是否返回 inode，即文件目录 ID	Bool	否
withFavoriteStatus	是否返回收藏状态	Bool	否

搜索

本页目录：

简介

搜索目录与文件

功能说明

示例代码

参数说明

继续获取搜索结果

功能说明

示例代码

参数说明

删除搜索任务

功能说明

示例代码

参数说明