事件列表

事件列表
- 事件樹
- 基本事件
  - message
  - notice
  - request
  - meta_event
  - socket
  - api

事件樹

├─ message
│    ├─ private
│    ├─ discuss
│    │    └─ @
│    │      └─ me
│    └─ group
│         └─ @
│           └─ me
├─ notice
│    ├─ group_upload
│    ├─ group_admin
│    │    ├─ set
│    │    └─ unset
│    ├─ group_decrease
│    │    ├─ leave
│    │    ├─ kick
│    │    └─ kick_me
│    ├─ group_increase
│    │    ├─ approve
│    │    └─ invite
│    └─ friend_add
├─ request 
│    ├─ friend
│    └─ group
|         ├─ add
|         └─ invite
├─ meta_event
|    ├─ lifecycle
|    └─ heartbeat
├─ error  
├─ ready  
├─ socket ※
│    ├─ connecting  
│    ├─ connect  
│    ├─ failed  
│    ├─ reconnecting  
│    ├─ reconnect  
│    ├─ reconnect_failed  
│    ├─ max_reconnect  
│    ├─ closing    
│    ├─ close    
│    └─ error
└─ api ※
     ├─ response  
     └─ send ※
         ├─ pre    
         └─ post  

※: 表示無法在該節點進行監聽

基本事件

前三個基本事件之說明，可以另外參考 CQHTTP API 的數據上報格式。

參數 context 可見事件列表。

事件類型	監聽器參數 `...args`	說明
message	`event` CQEvent `context` object `tags` CQTag[]	所有流入的訊息。
notice	`context` object	群文件上傳, 群管變動, 群成員增減, 好友添加…等QQ事件。
request	`context` object	好友請求, 群請求/群邀請…等QQ事件。
meta_event	`context` object	來自 CQHTTP API 的元事件。
error	`err` Error	應用層面的錯誤, 如 CQHttp API 消息格式錯誤, 響應超時… 等
ready	`this`	設定中啟用之連線均成功並初始化完成，可以開始調用API (送消息…等操作)。

message

notice

request

meta_event

| 事件類型 | 監聽器參數 | 說明 | | - | - | - | | meta_event.lifecycle | context object | 生命周期。 | | meta_event.heartbeat | context object | 心跳。 |

socket

底層 socket 連線的事件, 可用於掌握連線狀況。

事件類型	監聽器參數	說明
socket.connecting	`type` WebsocketType `attempts` number	開始嘗試連線, 連線成功/失敗之前。
socket.connect	`type` WebsocketType `socket` WebSocketConnection `attempts` number	連線成功後，尚未初始化之前。
socket.failed	`type` WebsocketType `attempts` number	連線失敗。
socket.reconnecting	`type` WebsocketType `attempts` number	開始嘗試重新連線, 若存在持續中的連線, 則先斷線。
socket.reconnect	`type` WebsocketType `attempts` number	重連成功。
socket.reconnect_failed	`type` WebsocketType `attempts` number	重連失敗。
socket.max_reconnect	`type` WebsocketType `attempts` number	已抵達重連次數上限。
socket.closing	`type` WebsocketType	連線關閉之前。
socket.close	`type` WebsocketType `code` number `desc` string	連線關閉。(連線關閉代碼 `code` 可參照 RFC 文件))
socket.error	`type` WebsocketType `err` Error	連線錯誤。若該事件無監聽器，則會安裝默認監聽器，固定拋出例外。

api

node-cq-websocket

A Node SDK for developing QQ chatbots based on WebSocket, which is depending on CoolQ and CQHTTP API plugin.