公告

功能概述

本模組用於接收處理講師、助教和管理員等用戶的公告操作。

初始化及銷毀

在實例化該模組並進行使用之前，需要對 SDK 進行初始化配置，詳細請見參考文件。

線上檔案引入方式

// script 标签引入，根据版本号引入JS版本。
<script src="https://websdk.videocc.net/interactions-receive-sdk/0.24.0/lib/polyv-ir.umd.js"></script>

<script>
    const { Announcement } = window.PolyvIRSDK;
</script>

import 方式引入（推薦）

import { Announcement } from '@polyv/interactions-receive-sdk';

const announcementSdk = new Announcement();
// 销毁 SDK 实例，清除逻辑
announcementSdk.destroy();

使用流程

監聽「收到公告」事件

在講師/助教等發起端發送公告後，announcementSdk.events.BULLETIN 事件會被觸發，事件參數中包含公告 ID 及內容，接入方可以監聽此事件並根據內容進行展示。

announcementSdk.on(announcementSdk.events.BULLETIN, function(msg) {
  console.log(`收到公告，公告ID：` + msg.id + `，公告内容：` + msg.content);
});

監聽「關閉公告」事件

發起端關閉公告後，announcementSdk.events.REMOVE_BULLETIN 事件會被觸發，接入方可以據此移除公告顯示。

announcementSdk.on(announcementSdk.events.REMOVE_BULLETIN, function(msg) {
  console.log('公告已关闭：' + msg.id);
});

注意

如果不再需要使用公告 SDK 時，請呼叫 SDK 實例的 destroy 方法來銷毀實例。