一、EventNotify
事件通知类，来自云端的事件通知，具体的通知内容实际是由通知的数据决定的。
- 以下方法说明中明确提供不推荐使用的方法，即为不建议开发者调用或者是开发者不应该进行任何数据修改。
- 以下文档中未提及的方法均属于不推荐使用的方法
二、Reference
以下为此类中关联的Class及相关说明
| 类名 | 类型 | 说明 |
|---|---|---|
| EventNotifyHelper | 辅助类 | 事件通知辅助处理类，详情请参考 API-EventNotifyHelper |
三、Field
以下为此类中的常用字段及说明。
3.1、Attributes
由于设备对象包含的属性较多，不一一罗列其属性的getter/setter方法，以下字段都支持对应的方法，方法列表中不再赘述。大部分情况下，以下属性为仅读属性
| 字段名 | 字段类型 | getter支持返回null | 说明 |
|---|---|---|---|
| fromType | byte | - | 通用事件通知，一般不需要使用 |
| fromId | int | - | 消息来源ID，根据来源类型确认该字段所属对象，可能是服务端、设备或 APP。来自服务端时 ID 为0 |
| notifyFlags | byte | - | 消息标识 |
| messageType | short | - | 消息类型标识 |
| payload | byte[] | 否 | 数据内容 |
3.2、NotifyFlags
数据类型标识
| 位 | 说明 |
|---|---|
| 0 | 来自 Server 事件 |
| 1 | 来自 Device 事件 |
| 2 | 来自 APP 事件 |
| 3 | 收到事件以后要不要应用，默认不需要应答 |
3.3、MessageType
消息类型
| 字段名 | 字段类型 | 值 | 说明 |
|---|---|---|---|
| MSG_TYPE_DATA_POINT_CHANGED | int | 0x01 | 设备通知，数据端点变化通知 |
| MSG_TYPE_DATA_POINT_ALERT | int | 0x02 | 设备告警，数据端点变化引起的告警 |
| MSG_TYPE_DEVICE_SHARE | int | 0x03 | 设备分享，设备管理员发出的分享 |
| MSG_TYPE_PUSH_MSG | int | 0x04 | 消息广播推送 |
| MSG_TYPE_DEVICE_PROP_CHANGE | int | 0x05 | 设备属性变化通知 |
| MSG_TYPE_SUBSCRIPTION_CHANGE | int | 0x06 | 设备与用户订阅关系变化通知 |
| MSG_TYPE_ONLINE_STATE_CHANGE | int | 0x07 | 设备在线状态变化通知 |
| MSG_TYPE_ONLINE_STATE_ALERT | int | 0x08 | 设备在线状态告警 |
| MSG_TYPE_HOME_MESSAGE_NOTIFY | int | 0x09 | 家庭消息通知，留言板消息 |
| MSG_TYPE_HOME_INVITE | int | 0x0a | 家庭邀请通知 |
| MSG_TYPE_HOME_DEVICE_PERMISSION_CHANGED | int | 0x0b | 家庭设备权限变化 |
| MSG_TYPE_HOME_MEMBER_CHANGED | int | 0x0c | 家庭成员变化 |
| MSG_TYPE_HOME_DEVICE_CHANGED | int | 0x0d | 家庭设备变化 |
四、Methods
以下方法为开发过程常用的方法说明，参数说明及返回值说明。此处仅提供了推荐开发者使用及可能需要使用的方法，部分未列出方法请根据实际情况评估调用。
4.1、isFromServer
public boolean isFromServer()- 方法说明：
判断当前消息是否来自服务端，来自服务端则 fromId 的值为0
- 返回值：来自服务端返回 true，否则返回 false
4.2、isFromDevice
public boolean isFromDevice()- 方法说明：
判断当前消息是否来自设备
- 返回值：来自设备返回 true，否则返回 false
4.3、isFromApp
public boolean isFromApp()- 方法说明：
判断当前消息是否来自 APP
- 返回值：来自 APP 返回 true，否则返回 false
4.4、isNeedResponse
public boolean isNeedResponse()- 方法说明：
是否需要应答事件通知，一般情况下都不需要，可以不关注此方法
- 返回值：若需要应答返回 true，否则返回 false
五、更新日志
| 日期 | 更新内容 |
|---|---|
| 2018-08-29 | 初稿，自 X-MQTT SDK v6.2版本起 |
