互動功能

本文檔主要提供互動功能 SDK 單一實例取得 API 說明。

一、安裝互動接收端 SDK

觀看頁 SDK 預設不會載入互動功能接收端 SDK，如需使用互動功能，請在 watchCore.setup() 之後呼叫該方法載入互動功能接收端 SDK。

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

範例：

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

二、取得互動設定資訊

用於取得管理後台設定的互動功能資訊。

API 方法： getInteractSetting(): InteractSetting

回傳值說明： 互動功能設定資訊，InteractSetting 類型，詳細類型說明如下

範例：

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

從 v0.9.0 版本開始支援

參數說明：

• params：Object 類型，必傳，詳細類型說明如下

十八、取得圖文直播 SDK 單一實例

圖文直播功能開發文件： 圖文直播 SDK、 圖文直播元件

API 方法： getTuwen(): Tuwen

回傳值說明： 圖文直播 SDK 單一實例，Tuwen 類型

十九、取得雲席 SDK 單一實例

API 方法： getSeatTable(): SeatTable

回傳值說明： 雲席 SDK 單一實例，SeatTable 類型

二十、設定雲席資訊

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

從 v0.10.0 版本開始支援

二十一、取得話題PK SDK 單一實例

話題PK功能開發文件： 話題PK SDK、 話題PK元件

API 方法： getTopicPK(): Topic

回傳值說明： 話題PK SDK 單一實例，Topic 類型

二十二、取得搶答 SDK 單一實例

API 方法： getRushAnswer(): RushAnswer

回傳值說明： 搶答 SDK 單一實例，RushAnswer 類型

二十三、取得商品庫按鈕點擊提示模板配置

API 方法： getProductLinkJumpTipDetail(): undefined | ProductLinkJumpTipDetail

從 v1.3.0 版本開始支援

回傳值說明： 商品庫按鈕點擊提示模板，undefined | ProductLinkJumpTipDetail 類型

二十四、地址管理 SDK 單一實例

API 方法： getAddressManagement(): AddressManagement

從 v1.5.0 版本開始支援

回傳值說明： 地址管理 SDK 單一實例，AddressManagement 類型

二十五、訂單 SDK 單一實例

API 方法： getOrder(): Order

從 v1.5.0 版本開始支援

回傳值說明： 訂單管理 SDK 單一實例，Order 類型

二十六、取得抽獎隱私協議的資料

API 方法： getLotteryPrivacyDetail(): LotteryPrivacyDetail

從 v1.4.0 版本開始支援

回傳值說明： LotteryPrivacyDetail 類型，詳細類型說明如下

二十七、解析商品詳情

API 方法： parseProductDetail(productGoodData: ProductGoodData): Promise<ParseProductDetail>

從 v1.11.0 版本開始支援

從 v2.6.0 版本開始廢棄

參數說明：

• productGoodData：ProductGoodData 類型，必傳，詳細類型說明如下