互动功能

本文档主要提供互动功能 SDK 单一实例获取 Api 说明。

一、安装互动接收端 SDK

观看页 SDK 默认不会加载互动功能接收端 SDK，如需使用互动功能，请在 watchCore.setup() 之后调用该方法加载互动功能接收端 SDK。

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

示例：

// 安装观看页 SDK
await watchCore.setup();
// 加载互动功能
await watchCore.interactReceive.setupIarCore();
// 加载后即可获取互动功能单一实例

二、获取互动设置信息

用于获取管理后台设置的互动功能信息。

Api 方法： getInteractSetting(): InteractSetting

返回值说明： 互动功能设置信息，InteractSetting 类型，详细类型说明如下

属性名	说明	类型
recruitmentEnabled	招聘直播开关	boolean
productEnabled	商品库开关	boolean
productTrackEnabled	商品库数据上报开关	boolean
productLinkJumpTipEnabled	商品库链接跳转提示开关	boolean
enrollLotteryEnabled	报名抽奖开关	boolean
lotteryManualEndEnabled	抽奖手动结束开关	boolean
conditionLotteryEnabled	条件抽奖开关	boolean
conditionLotteryAutoPopperEnabled	条件抽奖是否自动弹窗开关	boolean
watchFeedbackEnabled	投诉反馈开关	boolean
voteActiveEnabled	投票活动开关	boolean
redpackEnabled	互动红包开关	boolean
redpackImage	红包背景图	string
redpackRainBottomImage	红包雨底部背景图	string
redpackRainImages	红包雨下落物图片	string[]
seatTableEnabled	云席功能开关	boolean
seatTableTemplate	云席模板	SeatTableTemplate
seatMaxNumber	嘉宾普通云席最大数量	number
seatVipMaxNumber	嘉宾 vip 云席最大数量	number
seatCustomTextEnabled	云席自定义文案开关	boolean
seatCustomText	云席自定义文案	string
seatGuestCardEnabled	云席嘉宾证开关	boolean
lotteryGiftButtonTextCH	抽奖按钮中文文案	string
lotteryGiftButtonTextEN	抽奖按钮英文文案	string
productHotEffectEnabled	是否显示热卖特效	boolean
productHotEffectTips	热卖词数据	ProductHotEffectTips

示例：

const settingInfo = watchCore.interactReceive.getInteractSetting();
console.log('商品库开关', settingInfo.productEnabled);

三、获取公告 SDK 单一实例

公告功能开发文档： 公告 SDK、 公告组件

Api 方法： getAnnouncement(): Announcement

返回值说明： 公告 SDK 单一实例，Announcement 类型

四、获取签到 SDK 单一实例

签到功能开发文档： 签到 SDK、 签到组件

Api 方法： getCheckIn(): CheckIn

返回值说明： 签到 SDK 单一实例，CheckIn 类型

五、获取答题卡 SDK 单一实例

答题卡功能开发文档： 答题卡 SDK、 答题卡组件

Api 方法： getAnswerCard(): AnswerCard

返回值说明： 答题卡 SDK 单一实例，AnswerCard 类型

六、获取问卷 SDK 单一实例

问卷功能开发文档： 问卷 SDK、 问卷组件

Api 方法： getQuestionnaire(): Questionnaire

返回值说明： 问卷 SDK 单一实例，Questionnaire 类型

七、获取问答 SDK 单一实例

问答功能开发文档： 问答 SDK、 问答组件

Api 方法： getQuestionAnswer(): QuestionAnswer

返回值说明： 问答 SDK 单一实例，QuestionAnswer 类型

八、获取卡片推送 SDK 单一实例

卡片推送功能开发文档： 卡片推送 SDK、 卡片推送组件

Api 方法： getPushCard(): PushCard

返回值说明： 卡片推送 SDK 单一实例，PushCard 类型

九、获取抽奖 SDK 单一实例

抽奖功能开发文档： 抽奖 SDK、 抽奖组件

Api 方法： getLottery(): Lottery

返回值说明： 抽奖 SDK 单一实例，Lottery 类型

十、获取条件抽奖 SDK 单一实例

条件抽奖功能开发文档： 条件抽奖 SDK、 条件抽奖组件

Api 方法： getWelfareLottery(): WelfareLottery

返回值说明： 条件抽奖 SDK 单一实例，WelfareLottery 类型

十一、获取报名抽奖 SDK 单一实例

报名抽奖功能开发文档： 报名抽奖 SDK、 报名抽奖组件

Api 方法： getEnrollLottery(): EnrollLottery

返回值说明： 报名抽奖 SDK 单一实例，EnrollLottery 类型

十二、获取红包 SDK 单一实例

红包功能开发文档： 红包组件

Api 方法： getRedpack(): RedEnvelope

返回值说明： 红包 SDK 单一实例，RedEnvelope 类型

十三、获取红包雨 SDK 单一实例

目前红包雨和红包共用一份 文档

Api 方法： getRedpackRain(): RedpackRain

返回值说明： 红包雨 SDK 单一实例，RedpackRain 类型

十四、获取投票 SDK 单一实例

暂无相关文档，后续补充...

Api 方法： getVote(): Vote

返回值说明： 投票 SDK 单一实例，Vote 类型

十五、获取反馈 SDK 单一实例

暂无相关文档，后续补充...

Api 方法： getFeedBack(): FeedBack

返回值说明： 反馈 SDK 单一实例，FeedBack 类型

十六、获取商品库 SDK 单一实例

商品库功能开发文档： 商品库 SDK、 商品库组件

Api 方法： getProduct(): Product

返回值说明： 商品库 SDK 单一实例，Product 类型

十七、商品库回放

Api 方法： processProductReplay(params: Object): void

参数说明：

• params：undefined，Object 类型，必传，详细类型说明如下

参数名	说明	类型	必须	默认值
currentTime	当前播放时间，单位：秒	number	是	-
durationTime	播放总时长，单位：秒	number	是	-

十八、获取图文直播 SDK 单一实例

图文直播功能开发文档： 图文直播 SDK、 图文直播组件

Api 方法： getTuwen(): Tuwen

返回值说明： 图文直播 SDK 单一实例，Tuwen 类型

十九、获取云席 SDK 单一实例

Api 方法： getSeatTable(): SeatTable

返回值说明： 云席 SDK 单一实例，SeatTable 类型

二十、设置云席信息

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

二十一、获取话题PK SDK 单一实例

话题PK功能开发文档： 话题PK SDK、 话题PK组件

Api 方法： getTopicPK(): Topic

返回值说明： 话题PK SDK 单一实例，Topic 类型

二十二、获取抢答 SDK 单一实例

Api 方法： getRushAnswer(): RushAnswer

返回值说明： 抢答 SDK 单一实例，RushAnswer 类型

二十三、获取商品库按钮点击提示模板配置

Api 方法： getProductLinkJumpTipDetail(): undefined | ProductLinkJumpTipDetail

返回值说明： 商品库按钮点击提示模板，undefined | ProductLinkJumpTipDetail 类型

二十四、地址管理 SDK 单一实例

Api 方法： getAddressManagement(): AddressManagement

返回值说明： 地址管理 SDK 单一实例，AddressManagement 类型

二十五、订单 SDK 单一实例

Api 方法： getOrder(): Order

返回值说明： 订单管理 SDK 单一实例，Order 类型

二十六、获取抽奖隐私协议的数据

Api 方法： getLotteryPrivacyDetail(): LotteryPrivacyDetail

返回值说明： LotteryPrivacyDetail 类型，详细类型说明如下

属性名	说明	类型
privacyContent	抽奖隐私协议内容	undefined | string
lotteryActivityPrivacyEnabled	抽奖活动隐私协议开关	YN