vRp.CD2g_test/notify
kercylan98 22449ff5c3 docs: 优化 README.md 可读性 2024-01-15 17:27:02 +08:00
..
notifies docs: 优化 README.md 可读性 2024-01-15 17:27:02 +08:00
senders docs: 优化 README.md 可读性 2024-01-15 17:27:02 +08:00
README.md docs: 优化 README.md 可读性 2024-01-15 17:27:02 +08:00
doc.go 文档优化 2023-06-12 11:30:08 +08:00
manager.go refactor: room 包移除大量 error 返回,增加易于房间操作 Helper 数据结构,可通过 Manager.GetHelper 和 room.NewHelper 获取 2023-07-28 10:48:45 +08:00
notify.go 飞书通知推送基本实现 2023-04-27 19:48:30 +08:00
sender.go 飞书机器人通知实现 2023-06-13 16:14:29 +08:00

README.md

Notify

Go doc

notify 包含了对外部第三方通知的实现,如机器人消息等

目录导航

列出了该 package 下所有的函数及类型定义,可通过目录导航进行快捷跳转 ❤️

展开 / 折叠目录导航

包级函数定义

函数名称 描述
NewManager 通过指定的 Sender 创建一个通知管理器, senders 包中提供了一些内置的 Sender

类型定义

类型 名称 描述
STRUCT Manager 通知管理器,可用于将通知同时发送至多个渠道
INTERFACE Notify 通用通知接口定义
INTERFACE Sender 通知发送器接口声明

详情信息

func NewManager(senders ...Sender) *Manager

通过指定的 Sender 创建一个通知管理器, senders 包中提供了一些内置的 Sender


Manager STRUCT

通知管理器,可用于将通知同时发送至多个渠道

type Manager struct {
	senders       []Sender
	notifyChannel chan Notify
	closeChannel  chan struct{}
}

func (*Manager) PushNotify(notify Notify)

推送通知


func (*Manager) Release()

释放通知管理器


Notify INTERFACE

通用通知接口定义

type Notify interface {
	Format() (string, error)
}

Sender INTERFACE

通知发送器接口声明

type Sender interface {
	Push(notify Notify) error
}