H5 文件的制作与使用

7.1 获取桥接层的唯一实例

// 步数、页数变更回调参数
interface OnPageChangeParams {
    page: number; // 当前页数，从 1 开始
    step: number; // 当前步数，从 1 开始
    oldPage: number; // 原页数，从 1 开始
    oldStep: number; // 原步数，从 1 开始
    taskID: string; // 任务ID
}

// 操作记录类型
enum RecordType {
    Push = 1, // 追加，对应于 pushRecord 接口
    Pop, // 移除最新一个，对应于 popRecord 接口
    Replace, // 全量替换，对应于 replaceRecordStack 接口
    Clear, // 清空，对应于 clearRecordStack 接口
    Stop = 100, // 停止音视频的场景
    LateJoinRoom = 101, // 后进房场景
    Back = 102 // 操作失败回退场景
}

// 操作记录列表变更回调参数
interface OnRecordChangeParams {
    recordList?: any[]; // 当前操作列表，recordType = 100 时不存在
    oldRecordList?: any[]; // 原操作列表，recordType = 100 时不存在
    taskID: string; // 任务ID
    recordType: RecordType; // 操作记录类型
    push: boolean; // 当前操作是否是远端推送
}

// 失败回调参数
interface OnErrorParams {
    code: number; // 错误码
    msg: string; // 错误描述
    data?: any; // 业务参数
    error?: Error; // 错误堆栈
}

// 步数、页数变更回调
type pageChangeCallback = (params: OnPageChangeParams) => Promise<any>;

// 操作记录变更回调
type recordChangeCallback = (params: OnRecordChangeParams) => Promise<any>;

// 错误回调
type errorCallback = (params: OnErrorParams) => void;

// 获取实例需要传入的参数
interface BridgeOptions {
    onPageChange: pageChangeCallback; // 页数、步数变更回调
    onRecordChange: recordChangeCallback; // 记录变更回调
    onError?: errorCallback; // 错误回调，可选
}

// 获取 ZEGOBridge 单例
static getInstance(options: BridgeOptions): Bridge;

7.2 通知桥接层文件准备就绪

// 页面初始数据
interface InitData {
    page: number; // 文件初始所在页数，从 1 开始
    step: number; // 文件初始当前页所在步数，从 1 开始
    pageCount: number; // 文件总页数
    maxSteps: number[]; // 文件所有页对应总步数
}

/**
 * 通知桥接层页面准备就绪
 *
 * 调用时机：引入脚本成功，页面准备就绪，可以进行多端同步的时候
 *
 * note：一般情况下可在 页面 load 的事件回调中调用
 *
 * @param data 页面初始数据
 */
getReady(data: InitData): void

7.3 请求翻页/跳步

/**
 * 发送翻页、跳步请求
 *
 * 调用时机：页面准备就绪，getReady 调用完成后，需要翻页、跳步的时候
 *
 * note：这里只是发送翻页、跳步请求，并不代表请求成功，具体操作请在 onPageChange 回调中执行
 *
 * @param page 目标页数
 *
 * @param step 目标步数，选填，不填默认为 1，表示跳转到当前页第一步
 *
 * @return 请求任务ID，唯一标识
 */
requestChangePage(page: number, step?: number): string

7.4 请求执行其它操作

ZEGOBridge 提供了 4 个接口来组合页面的操作，所有接口都用来更新当前页的操作记录列表 recordList，H5 文件需要保证组合调用后 recordList 不能超过 ZEGO 桥接层的最大长度限制，超过限制，桥接层会在 onError 回调中抛出，当前的一次操作请求会无效。

7.4.1 追加一条当前页的操作记录

/**
 * 追加一条操作记录
 *
 * 调用时机：页面准备就绪，getReady 调用完成后，需要追加操作的时候
 *
 * note：这里只是发送请求，并不代表请求成功，具体操作请在 onRecordChange 回调中执行
 *
 * note：如果开发者需要关注操作历史记录，请使用该方法
 *
 * @param record 操作记录
 *
 * @return 请求任务ID，唯一标识
 */
pushRecord(record: string | number | Array<any> | object | boolean | null): string

7.4.2 移除最近一次操作记录

/**
 * 移除最近一次操作记录
 *
 * 调用时机：页面准备就绪，getReady 调用完成后，需要移除最近一次操作记录的时候
 *
 * note：这里只是发送请求，并不代表请求成功，具体操作请在 onRecordChange 回调中执行
 *
 * @return 请求任务ID，唯一标识和最近一次操作记录
 */
popRecord(): { taskID: string; record: string | number | Array<any> | object | boolean | null }

7.4.3 清空当前页操作记录

/**
 * 清空当前页操作记录
 *
 * 调用时机：页面准备就绪，getReady 调用完成后，需要清空当前页操作记录的时候
 *
 * note：这里只是发送请求，并不代表请求成功，具体操作请在 onRecordChange 回调中执行
 *
 * note：每当页数变更时，脚本内部已将操作记录清空，正常情况下开发者无需用到此方法
 *
 * @param record 操作记录
 *
 * @return 请求任务ID，唯一标识
 */
clearRecordStack(): string

7.4.4 全量替换当前页的操作记录列表

/**
 * 替换当前页操作记录
 *
 * 调用时机：页面准备就绪，getReady 调用完成后，需要替换当前页操作记录的时候
 *
 * note：这里只是发送请求，并不代表请求成功，具体操作请在 onRecordChange 回调中执行
 *
 * note：全量替换当前的操作记录列表，如果开发者不需要关注操作历史记录，请使该方法
 *
 * @param record 操作记录
 *
 * @return 请求任务ID，唯一标识
 */
replaceRecordStack(record: string | number | Array<any> | object | boolean | null): string