卡片推播

一、功能概述

本模組主要用於接收和處理直播間的卡片推播功能，包括取得卡片資訊、記錄領取狀態等。

二、Api 方法

2.1 取得當前推播的卡片資料

說明： 取得當前直播間正在推播的卡片資訊

Api 方法： getPushCardData(): Promise<undefined | PushCardData>

回傳值說明： 卡片資料，如果沒有正在推播的卡片則回傳 undefined，Promise<undefined | PushCardData> 類型

範例：

// 获取当前推送的卡片
const cardData = await watchCore.pushCard.getPushCardData();
console.log('卡片图片链接:', cardData.cardImage);
console.log('等待显示时间(秒):', cardData.conditionValue);
console.log('倒计时文案:', cardData.countdownMsg);
console.log('卡片倒计时(秒):', cardData.duration);
console.log('是否有卡片入口:', cardData.enterEnabled);
console.log('入口图片链接:', cardData.enterImage);
console.log('封面类型:', cardData.imageType);
console.log('跳转链接:', cardData.link);
console.log('移动端跳转链接:', cardData.mobileLink);
console.log('桌面端跳转链接:', cardData.pcLink);
console.log('微信小程序原始ID:', cardData.wxMiniprogramOriginalId);
console.log('微信小程序appid:', cardData.wxMiniprogramAppId);
console.log('页面路径:', cardData.wxMiniprogramLink);
console.log('是否有配置链接:', cardData.linkEnabled);
console.log('打开链接方式:', cardData.redirectType);
console.log('弹出方式:', cardData.showCondition);
console.log('卡片标题:', cardData.title);
console.log('链接类型:', cardData.hrefType);

2.2 記錄卡片領取操作

說明： 使用者領取卡片時呼叫，記錄領取狀態

Api 方法： recordObtainCard(): Promise<void>

範例：

// 用户领取卡片
await watchCore.pushCard.recordObtainCard();
console.log('卡片领取成功');

三、模組事件

3.1 卡片推播開始事件

說明： 當講師/助教發起卡片推播時觸發，包含卡片的詳細資訊

Event 事件： PushCardEvents.PushStart

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.pushCard.eventEmitter.on(PushCardEvents.PushStart, (data) => {
  console.log('卡片推送开始', data.cardId, data.cardData);
});

3.2 取消卡片推播事件

說明： 當卡片推播被取消時觸發

Event 事件： PushCardEvents.PushCancel

範例：

watchCore.pushCard.eventEmitter.on(PushCardEvents.PushCancel, () => {
  console.log('卡片推送已取消');
});