伯索开放平台
首页API文档SDK文档伯索官网
首页API文档SDK文档伯索官网
  1. 文档解析接入方式
  • 快速入门
    • SDK简介
      • SDK简介
    • SDK支持的业务场景
      • SDK支持的业务场景
    • 产品特色
      • 产品特色
  • 产品指南
    • 实时课堂功能介绍
      • 实时课堂功能介绍
    • 微课功能介绍
      • 微课功能介绍
    • 作业批改功能介绍
      • 作业批改功能介绍
    • 上传课件功能介绍
      • 上传课件功能介绍
    • SDK后台功能介绍
      • SDK后台功能介绍
  • 最佳实践
    • 最佳实践
  • 接入流程说明
    • SDK对接标准流程说明
      • SDK对接标准流程说明
    • 基础概念说明
      • 基础概念说明
  • SDK帮助文档
    • 直播SDK接入
      • WEB版本
        • WEB版本
      • iOS版本
        • IOS版本
      • Android版本
        • Android版本
    • 微课SDK接入
      • WEB版本
        • WEB版本
      • iOS版本
        • IOS版本
      • Android版本
        • Android版本
    • 批注SDK接入
      • Web版本
        • Web版本
      • iOS版本
        • IOS版本
      • Android版本
        • Android版本
    • 签名加密
      • 签名加密
    • 回调接口接入流程
      • 回调接口接入流程
    • 文档解析接入方式
      • 文档解析接入方式
    • 历史课堂接入方式
      • 历史课堂接入方式
    • 历史课堂转视频接入方式
      • 历史课堂转视频接入方式
    • 历史课堂/微课下载接口
      • 历史课堂/微课下载接口
  • Open API帮助文档
    • Open API 主要功能
    • Open API集成常用场景
    • 数据字典
    • 接入须知
      • 调用流程
      • 在线调试
      • 通用错误码
    • 用户信息管理
      • 添加用户
      • 修改密码
      • 删除用户
      • 更新用户
      • 用户精确查询
      • 查询多个用户
      • 用户访问Token
      • 验证用户Token有效期
    • 教材包管理
      • 查询机构教材包
      • 查询教材包内教材
      • 向学生分发教材包
    • 实时课堂管理
      • 创建实时课堂
      • 创建实时课堂(班)
      • 更新实时课堂
      • 更新实时课堂(班)
      • 删除实时课堂
      • 查询实时课堂列表
      • 更新实时课堂下听众用户
      • 获取实时课堂监控地址
      • 控制单个学员是否可以回看单次课
      • 获取单个课堂的回看地址
      • 删除单个历史课堂
      • 获取课堂考勤数据
      • 获取历史课堂信息
      • 获取历史课堂观看数据
      • 获取课堂互动信息
      • 获取课堂列表(新)
      • 获取实时课堂旁听链接
    • 班级管理
      • 创建班级
      • 更新班级
      • 删除班级
      • 查询班级列表
      • 向班级中添加学生
      • 从班级中移除学生
      • 更换学生所在班级
      • 老师列表中查询机构分校学科
      • 根据班级获取获取班级详情和人员信息
    • 学情数据
      • 获取学生课堂明细数据
      • 获取学生巩固明细数据
      • 获取学生测验明细数据
      • 获取学生辅导明细数据
      • 获取学生积分明细数据
    • 商城管理
      • 获取商品详情
      • 获取商品列表
      • 获取分校自定义商品栏目列表
      • 订单查询
      • 订单详情查询
    • 作业管理
      • 查询学生作业列表
      • 查询老师作业列表
    • 测验管理
      • 查询机构测评列表
      • 获取测评统计
      • 查询机构测验列表
      • 获取测验明细
  • 产品更新记录
    • Open API 更新日志
    • SDK 更新日志
  • 常见问题
    • PPT制作事项
    • 课件常见问题与解决方法
    • 网络相关问题
    • 声音相关问题
    • 网络测速
  • 推荐
    • 浏览器推荐
    • 常见软件推荐
    • 教育硬件推荐
  1. 文档解析接入方式

文档解析接入方式

客户端可以调用sdkClient.insertObject方法插入文件。insertObject方法接收fileObject结构的参数。如果外部文件的地址是非公开、需要签名的或是具有有效期的,还需要在interfaces中实现getExtFileName方法,当fileObject对象中有info属性时,sdkClient会调用getExitFileName(info)获取该文件临时的访问地址
调用示例
fileObject结构
enum file_type { PPT,IMAGE, PDF, WORD, EXCEL, AUDIO, VIDEO }
interface fileObject{
  type: file_type; // 文件类型
  title: string; // 文件名称
  url: string; // 文件的可下载地址
  info: Array<any>; // 文件信息
}
💡
fileObject必须包含type属性,number类型,表示文件类型。目前支持PPT, IMAGE, PDF, WORD, EXCEL, AUDIO, VIDEO等类型。使用时请引用 PlasoStyleUpime.FILETYPE 里的宏定义对type属性进行赋值
PlasoStyleUpime.FILETYPE = {
    PPT, // 动态ppt
    IMAGE, // 图片
    PDF, // pdf
    WORD, // doc
    EXCEL, // xlsx/xls
    AUDIO, // 音频
    VIDEO // 视频
}
FILETYPE类型使用描述
IMAGEurl属性必须是可供下载图片的地址。title必须带有文件后缀名,否则会导致gif图片被当做jpeg图片插入
PDF/WORD/EXCELurl属性必须是可供下载的pdf文件的地址,文件类型仅用来显示文件类型的图标
AUDIO/VIDEO可以设置url属性为长期有效的、公开的可以访问的音视频文件全路径,或者设置info属性为表示文件信息的数组,可以通过getExtFileName(info)可以获取文件有效路径
PPT可以设置url属性为可以下载的ppt文件的地址(仅限直播SDK)
getExtFileName 传入表示文件信息的info数组,返回Promise,Promise的结果为文件地址。info数组的内容由使用机构自己定义,保证直播课堂的老师端/学生端、历史课堂、微课里都能调用getExtFileName(info)得到文件的有效路径
function getExtFileName(info: Array<any>) : Promise<string>;
资料中心
客户端在创建sdkClient时,通过interfaces参数传入showResourceCenter回调函数,实时课堂speaker/assitant角色界面、微课界面会增加“资料中心”按钮,点击工具栏的文件图标后显示。点击该按钮后会执行showResourceCenter回调函数。客户端可以在sdk界面上层显示资料中心窗口,当用户选择文件后,客户端再调用sdkClient.insertObject方法将资料中心的文件以fileObject的结构插入sdk
修改于 2025-03-20 06:41:00
上一页
文档解析接入方式
下一页
历史课堂接入方式
Built with