IResourceProvider。该能力可用于实时课堂和极速课堂。IResourceProvider。课堂基础初始化见《实时课堂/Harmony》;服务端 URL 契约见《服务端接口与协议/04-资料中心与文件URL》。私有资源 URL 的有效期由业务方按安全策略决定,并非 SDK 回调协议的强制要求。supportResourceCenter(): boolean { return true; }
showResourceCenter(_checkAi: boolean): void {
// 打开业务资料中心页面。
}
dismissResourceCenter(): void {
// 关闭业务资料中心页面。
}StyleUpime.getInstance().setResourceProvider(provider) 注册 Provider。若不支持资料中心则返回 false;所有失败分支必须调用 callback.onFilePath(null)。PlasoUpimeBoard.getInstance().insertObject。根据 info 是公开 URL 还是业务文件标识,分别走以下两条路径。import { PlasoUpimeBoard, UpimeObject } from 'styleupime';
PlasoUpimeBoard.getInstance().insertObject(UpimeObject.TYPE_PDF, info, title);info 类型 | 支持类型 | 行为 |
|---|---|---|
string | TYPE_PPT、TYPE_DOC、TYPE_XLS、TYPE_PDF、TYPE_AUDIO、TYPE_VIDEO | 必须是可直接访问的 HTTP URL;SDK 直接插入。 |
List | 推荐音视频 | SDK 调用 getExtFileName;业务端返回授权后的可访问完整 URL。 |
getExtFileName(info: Object | null, callback: IResourceCallback): void {
requestFileUrl(info)
.then((url: string) => callback.onFilePath(url))
.catch(() => callback.onFilePath(null));
}info 应为业务文件标识。服务端须校验访问权限并返回可访问的完整 URL,不允许客户端拼接对象存储路径或信任任意外部 URL。info:PlasoUpimeBoard.getInstance().insertObject(
UpimeObject.TYPE_PDF,
'https://cdn.example.com/courseware/chapter-1.pdf',
'第一章.pdf'
);getExtFileName。URL 应使用 HTTPS 且在课堂期间可访问。['file', { id: fileId }],由 getExtFileName 换取 URL:getExtFileName(info: Object | null, callback: IResourceCallback): void {
const fileId = extractFileId(info);
if (!fileId) {
callback.onFilePath(null);
return;
}
requestFileUrl(fileId)
.then((url: string) => callback.onFilePath(url || null))
.catch(() => callback.onFilePath(null));
}null;不能在客户端保存 appKey、对象存储私钥或永久下载地址。getPreParseFileName 请求每个解析产物的可访问完整 URL。info 必须为 List,类型可为 TYPE_I_SPRING_PPT、TYPE_DOC、TYPE_XLS、TYPE_PDF。SDK 会调用:getPreParseFileName(
info: Object | null, suffix: string | null, callback: IResourceCallback
): void {
requestParsedFileUrl(info, suffix)
.then((url: string) => callback.onFilePath(url))
.catch(() => callback.onFilePath(null));
}suffix 常见为 /1.jpg、/index.html、/ispring.html、/info.json。预解析任务、文件类型和服务端校验规则见《文件预解析/Harmony》。info 格式为 ['parsed', { id: 'parsed-file-001' }]。Harmony SDK 的插入方法可传入页数:const parsedInfo: Object[] = ['parsed', { id: 'parsed-file-001' }];
PlasoUpimeBoard.getInstance().insertObject(
UpimeObject.TYPE_PDF,
parsedInfo,
'课件.pdf',
12
);| 文件类型 | type | 额外参数 | 常见 suffix |
|---|---|---|---|
| iSpring PPT | TYPE_I_SPRING_PPT | 不传页数 | /index.html、/ispring.html |
TYPE_PDF | 传解析总页数 | /1.jpg、/info.json | |
| Word | TYPE_DOC | 传解析总页数 | /1.jpg、/info.json |
| Excel | TYPE_XLS | 传解析总页数 | /1.jpg、/info.json |
getPreParseFileName 的 info 是插入时的原始对象,suffix 是 SDK 请求的解析产物相对路径。客户端只提取文件 ID 后将 fileId + suffix 提交给业务服务端;服务端鉴权、校验 suffix、定位产物并返回可访问完整 URL。getPreParseFileName(
info: Object | null,
suffix: string | null,
callback: IResourceCallback
): void {
const fileId = extractFileId(info);
if (!fileId || !suffix) {
callback.onFilePath(null);
return;
}
requestParsedFileUrl(fileId, suffix)
.then((url: string) => callback.onFilePath(url || null))
.catch(() => callback.onFilePath(null));
}suffix 可能含图片处理查询参数,客户端应完整编码传递,服务端解码并校验后再签发 URL。OPEN_FILE_MODE_WINDOW 时,SDK 按需请求 HTML、页面图片和元数据。使用 OPEN_FILE_MODE_IMAGE 时,PDF、Word、Excel 可能以 suffix == "?" 请求原始文件 URL;业务服务端应按已校验的文件 ID 返回可访问的完整原始文件 URL,不能把 ? 拼入解析产物路径。supportResourceCenter() 返回 true 时课堂可显示入口,且能正确关闭资料中心。getExtFileName 并返回可访问的完整 URL。getPreParseFileName 请求均能按完整 suffix 返回可访问的完整 URL,失败时仅回调一次 null。appKey 或解析产物路径。