CQPlugin (spring-cq 4.14.0 API)

java.lang.Object
- net.lz1998.cq.robot.CQPlugin

```
public class CQPlugin
extends Object
```

字段概要

字段
限定符和类型字段和说明

static int MESSAGE_BLOCK

static int MESSAGE_IGNORE

字段
限定符和类型	字段和说明
`static int`	`MESSAGE_BLOCK`
`static int`	`MESSAGE_IGNORE`

构造器概要

构造器
构造器和说明

CQPlugin()

构造器
构造器和说明
`CQPlugin()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`onDiscussMessage(CoolQ cq, CQDiscussMessageEvent event)` 收到讨论组消息时调用此方法
`int`	`onFriendAddNotice(CoolQ cq, CQFriendAddNoticeEvent event)` 好友添加时调用此方法
`int`	`onFriendRequest(CoolQ cq, CQFriendRequestEvent event)` 加好友请求时调用此方法
`int`	`onGroupAdminNotice(CoolQ cq, CQGroupAdminNoticeEvent event)` 群管理员变动时调用此方法
`int`	`onGroupBanNotice(CoolQ cq, CQGroupBanNoticeEvent event)` 群禁言时调用此方法
`int`	`onGroupDecreaseNotice(CoolQ cq, CQGroupDecreaseNoticeEvent event)` 群成员减少时调用此方法
`int`	`onGroupIncreaseNotice(CoolQ cq, CQGroupIncreaseNoticeEvent event)` 群成员增加时调用此方法
`int`	`onGroupMessage(CoolQ cq, CQGroupMessageEvent event)` 收到群消息时调用此方法
`int`	`onGroupRequest(CoolQ cq, CQGroupRequestEvent event)` 加群请求/邀请时调用此方法
`int`	`onGroupUploadNotice(CoolQ cq, CQGroupUploadNoticeEvent event)` 群内有文件上传时调用此方法仅群文件上传表现为事件，好友发送文件在酷Q 中没有独立的事件，而是直接表现为好友消息，请注意在编写业务逻辑时进行判断。
`int`	`onHeartBeatMeta(CoolQ cq, CQHeartBeatMetaEvent event)` 收到心跳包时调用此方法心跳类型的元事件需要通过设置配置项 enable_heartbeat 为 true 开启，并可通过 heartbeat_interval 配置心跳间隔（单位毫秒）。
`int`	`onLifecycleMeta(CoolQ cq, CQLifecycleMetaEvent event)`
`int`	`onPrivateMessage(CoolQ cq, CQPrivateMessageEvent event)` 收到私聊消息时调用此方法

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - MESSAGE_BLOCK
```
public static final int MESSAGE_BLOCK
```
    另请参阅:
    
    常量字段值
  - MESSAGE_IGNORE
```
public static final int MESSAGE_IGNORE
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - CQPlugin
```
public CQPlugin()
```
- 方法详细资料
  - onPrivateMessage
```
public int onPrivateMessage(CoolQ cq,
                            CQPrivateMessageEvent event)
```
    收到私聊消息时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onGroupMessage
```
public int onGroupMessage(CoolQ cq,
                          CQGroupMessageEvent event)
```
    收到群消息时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onDiscussMessage
```
public int onDiscussMessage(CoolQ cq,
                            CQDiscussMessageEvent event)
```
    收到讨论组消息时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onGroupUploadNotice
```
public int onGroupUploadNotice(CoolQ cq,
                               CQGroupUploadNoticeEvent event)
```
    群内有文件上传时调用此方法仅群文件上传表现为事件，好友发送文件在酷Q 中没有独立的事件，而是直接表现为好友消息，请注意在编写业务逻辑时进行判断。
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onGroupAdminNotice
```
public int onGroupAdminNotice(CoolQ cq,
                              CQGroupAdminNoticeEvent event)
```
    群管理员变动时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onGroupDecreaseNotice
```
public int onGroupDecreaseNotice(CoolQ cq,
                                 CQGroupDecreaseNoticeEvent event)
```
    群成员减少时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onGroupIncreaseNotice
```
public int onGroupIncreaseNotice(CoolQ cq,
                                 CQGroupIncreaseNoticeEvent event)
```
    群成员增加时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onGroupBanNotice
```
public int onGroupBanNotice(CoolQ cq,
                            CQGroupBanNoticeEvent event)
```
    群禁言时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onFriendAddNotice
```
public int onFriendAddNotice(CoolQ cq,
                             CQFriendAddNoticeEvent event)
```
    好友添加时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onFriendRequest
```
public int onFriendRequest(CoolQ cq,
                           CQFriendRequestEvent event)
```
    加好友请求时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onGroupRequest
```
public int onGroupRequest(CoolQ cq,
                          CQGroupRequestEvent event)
```
    加群请求/邀请时调用此方法
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onHeartBeatMeta
```
public int onHeartBeatMeta(CoolQ cq,
                           CQHeartBeatMetaEvent event)
```
    收到心跳包时调用此方法心跳类型的元事件需要通过设置配置项 enable_heartbeat 为 true 开启，并可通过 heartbeat_interval 配置心跳间隔（单位毫秒）。
    
    参数:
    
    cq - 机器人对象
    
    event - 事件内容
    
    返回:
    
    是否继续处理下一个插件, MESSAGE_BLOCK表示不继续，MESSAGE_IGNORE表示继续
  - onLifecycleMeta
```
public int onLifecycleMeta(CoolQ cq,
                           CQLifecycleMetaEvent event)
```

类 CQPlugin

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

MESSAGE_BLOCK

MESSAGE_IGNORE

构造器详细资料

CQPlugin

方法详细资料

onPrivateMessage

onGroupMessage

onDiscussMessage

onGroupUploadNotice

onGroupAdminNotice

onGroupDecreaseNotice

onGroupIncreaseNotice

onGroupBanNotice

onFriendAddNotice

onFriendRequest

onGroupRequest

onHeartBeatMeta

onLifecycleMeta