# 公告系统

# 一、介绍

可用于获取公告信息、监听公告消息状态改变相关事件。使用前需要在后台配置相关公告。

# 二、使用

# 导入公告系统

import { bulletinSystem } from '@timi/mogs-sdk';
1

# 获取当前公告列表

const bulletins = await bulletinSystem.bulletins;
bulletins.forEach((bulletin) =>
  console.log(bulletin.id, bulletin.title, bulletin.content, bulletin.customStr)
);
1
2
3
4

# 监听公告改变事件

bulletinSystem.onBulletinChange((event) => {
  switch (event.type) {
    case bulletinSystem.BulletinChangeEventType.Add:
      console.log('公告新增:', event.bulletinId, event.currentValue);
      break;
    case bulletinSystem.BulletinChangeEventType.Update:
      console.log(
        '公告信息更新:',
        event.bulletinId,
        event.previousValue,
        event.currentValue
      );
      break;
    case bulletinSystem.BulletinChangeEventType.Remove:
      console.log('公告移除:', event.bulletinId, event.previousValue);
      break;
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 取消监听公告改变事件

function someHandler(event) {
  // ...
}
bulletinSystem.onBulletinChange(someHandler);

// 取消注册(一个之前注册过的)回调函数
bulletinSystem.offBulletinChange(someHandler);
// 或,取消注册所有回调函数
bulletinSystem.offBulletinChange();
1
2
3
4
5
6
7
8
9

TIP

更多公告系统的 API 请参考 公告系统