Card Push

1. Overview

This module is primarily used to receive and process the card push functionality in live streaming rooms, including retrieving card information and recording claim status.

2. API Methods

2.1 Get Current Push Card Data

Description: Retrieves the card information currently being pushed in the live streaming room.

API Method: getPushCardData(): Promise<undefined | PushCardData>

Return Value Description: Card data; returns undefined if no card is being pushed. Type: Promise<undefined | PushCardData>

Example:

// 获取当前推送的卡片
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 Record Card Claim Operation

Description: Called when a user claims a card, recording the claim status.

API Method: recordObtainCard(): Promise<void>

Example:

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

3. Module Events

3.1 Card Push Start Event

Description: Triggered when the instructor/assistant initiates a card push, containing detailed card information.

Event: PushCardEvents.PushStart

Callback Parameters: Object object. Detailed type description is as follows:

Example:

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

3.2 Card Push Cancel Event

Description: Triggered when the card push is canceled.

Event: PushCardEvents.PushCancel

Example:

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