接收 Tips 消息

功能简介

ZIM SDK 支持将用户的某些群组操作（如创建群组、解散群组等），转换为一条群组会话内的特殊类型消息（Tips 消息，枚举值为 32）。该种消息仅能由 ZIM 后台或 ZIM SDK 内部产生，用户不可自行插入本地会话，不可对其设置回执状态、表态和单独删除（但可通过删除会话内所有消息删除该消息）。

前提条件

在实现“接收 Tips 消息”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

实现流程

1 开通功能

请联系 ZEGO 技术支持开启单个或多个 Tips 消息特性，确认所需的消息事件。可开通的事件包含：

• 群创建。

• 群解散。

• 用户主动加群。

• 群内成员邀请群外用户。

• 群成员主动离开。

• 群内成员被踢出。

• 群资料变更，包含以下事件：

  “群资料变更” 仅为以下事件的集合，您在开通时，仍需指定所需的事件。

  • 群名变更。
  • 群头像变更。
  • 群公告变更。
  • 群禁言状态变更。

• 群成员变更：包含以下子事件：

  “群成员变更” 仅为以下事件的集合，您在开通时，仍需指定所需的事件。

  • 群主变更。
  • 群成员角色变更。
  • 群成员禁言状态变更。

2 接收消息

当群组会话中出现了相关事件，通过监听 onReceiveGroupMessage 回调，即可接收 Tips 消息。

如果 Tips 消息的事件（ZIMTipsMessageEvent）为群资料变更（ZIMTipsMessageEvent.GROUP_INFO_CHANGED）和群成员变更（ZIMTipsMessageEvent.GROUP_MEMBER_INFO_CHANGED），请遵循以下步骤：

1. 将 Tips 消息中的 changeInfo 转换为 ZIMTipsMessageGroupChangeInfo 或 ZIMTipsMessageGroupMemberChangeInfo 类型。
2. 根据 changeInfo 中的 type，了解具体事件（ZIMTipsMessageChangeInfoType ），从而确认 changeInfo 中应该读取的对应字段。对于非对应事件的字段，SDK 不会赋值。如需了解处理详情，可参考下文示例代码。

ZIMTipsMessageEvent 与 ZIMTipsMessageChangeInfoType 的对应关系如下表所示：

// 接收群组消息
zim.setEventHandler(new ZIMEventHandler(){
@Override
public void onReceiveGroupMessage(ZIM zim, List<ZIMMessage> messageList, String fromGroupID) {
        for (ZIMMessage message : messageList) {
            // 消息为 Tips
            if (message.getType() == ZIMMessageType.TIPS) {
                ZIMTipsMessage tipsMessage = (ZIMTipsMessage) message;
                // 如果 Tips 消息类型为群资料变更
                if (tipsMessage.event == ZIMTipsMessageEvent.GROUP_INFO_CHANGED) {
                    ZIMTipsMessageGroupChangeInfo info = (ZIMTipsMessageGroupChangeInfo)tipsMessage.changeInfo;
                    if (info.type == ZIMTipsMessageChangeInfoType.GROUP_DATA_CHANGED) {
                        if ((info.groupDataFlag & ZIMGroupDataFlag.NAME) == ZIMGroupDataFlag.NAME) {
                            // 群名变更
                            String newGroupName = info.groupName;
                        }

                        if ((info.groupDataFlag & ZIMGroupDataFlag.NOTICE) == ZIMGroupDataFlag.NOTICE) {
                            // 群公告变更
                            String newGroupNotice = info.groupNotice;
                        }

                        if ((info.groupDataFlag &  ZIMGroupDataFlag.AVATAR_URL) == ZIMGroupDataFlag.AVATAR_URL) {
                            // 群头像变更
                            String newGroupAvatarUrl = info.groupAvatarUrl;
                        }
                    }

                    // ... 业务逻辑
                } else if (tipsMessage.event == ZIMTipsMessageEvent.GROUP_MEMBER_INFO_CHANGED) {
                    ZIMTipsMessageGroupMemberChangeInfo memberInfo = (ZIMTipsMessageGroupMemberChangeInfo) tipsMessage.changeInfo;
                    // ... 业务逻辑
                }
                // ... 其他逻辑
            }
        }
    }
});