接收 Tips 消息

功能简介

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

说明

仅限 2.15.0 及以上版本的 ZIM SDK 支持此功能。

实现流程

1 开通功能

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

事件类型	子事件
群组管理	说明在开通本类型时，仅支持开通所有子事件。群创建群解散用户主动加群群内成员邀请群外用户群成员主动离开群内成员被踢出
群资料变更	说明在开通本类型时，请指定所需的子事件。群名变更群头像变更群公告变更群禁言状态变更
群成员变更	说明在开通本类型时，请指定所需的子事件。群主变更群成员角色变更群成员禁言状态变更

2 接收消息

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

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

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

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

事件（ZIMTipsMessageEvent）	枚举	枚举值	读取 ZIMTipsMessageGroupChangeInfo 操作
创建群组	GROUP_CREATED	1	无需操作
解散群组	GROUP_DISMISSED	2
用户主动入群	GROUP_JOINED	3
邀请用户入群	GROUP_INVITED	4
群内成员离群	GROUP_LEFT	5
群内成员被踢	GROUP_KICKED_OUT	6
群资料变更	GROUP_INFO_CHANGED	7	需要读取
额外信息（ZIMTipsMessageChangeInfoType）	枚举	枚举值	读取 ZIMTipsMessageGroupChangeInfo 操作
└群名、群头像、群公告多个变更	GROUP_DATA_CHANGED	1	参考示例代码，由 groupDataFlage 进行位运算，取群名，群公告、群头像其中某几个数据
└群公告变更	GROUP_NOTICE_CHANGED	2	读取 ZIMTipsMessageGroupChangeInfo 的 groupNotice 字段
└群名变更	GROUP_NAME_CHANGED	3	读取 ZIMTipsMessageGroupChangeInfo 的 groupName 字段
└群头像变更	GROUP_AVATAR_URL_CHANGED	4	读取 ZIMTipsMessageGroupChangeInfo 的 groupAvatarUrl 字段
└群禁言状态变更	GROUP_MUTE_CHANGED	5	读取 ZIMTipsMessageGroupChangeInfo 的 groupMutedInfo 字段
群成员变更	GROUP_MEMBER_INFO_CHANGED	8	根据额外信息而定
额外信息（ZIMTipsChangeInfoType）	枚举	枚举值	读取 ZIMTipsMessageGroupMemberChangeInfo 操作
└群主转移	GROUP_OWNER_TRANSFERRED	10	无需读取
└群成员角色变更	GROUP_MEMBER_ROLE_CHANGED	11	读取 ZIMTipsMessageGroupMemberChangeInfo 的 memberRole 字段
└群成员禁言状态变更	GROUP_MEMBER_MUTE_CHANGED	12	读取 ZIMTipsMessageGroupMemberChangeInfo 的 muteExpiredTime 字段

Untitled

// 接收群组消息
zim.setEventHandler(new ZIMEventHandler(){
@Override
public void onGroupMessageReceived(ZIM zim, List<ZIMMessage> messageList, ZIMMessageReceivedInfo info, 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;
                    // ... 业务逻辑
                }
                // ... 其他逻辑
            }
        }
    }
});

Copied!

Untitled

// 接收群组消息
void zim_event_handler::onGroupMessageReceived(
    zim::ZIM *, const std::vector<std::shared_ptr<zim::ZIMMessage>> &messageList,
    const ZIMMessageReceivedInfo info,
    const std::string &fromGroupID) {

    for (const auto &message: messageList) {
        // 消息为 Tips
        if (message->getType() == zim::ZIMMessageType::ZIM_MESSAGE_TYPE_TIPS) {
            auto tips_message = std::static_pointer_cast<zim::ZIMTipsMessage>(message);
            // 如果 Tips 消息类型为群资料变更
            if (tips_message->getEvent() == zim::ZIMTipsMessageEvent::ZIM_TIPS_MESSAGE_EVENT_GROUP_INFO_CHANGED) {
                auto info = std::static_pointer_cast<zim::ZIMTipsMessageGroupChangeInfo>(tips_message->getChangeInfo());

                if (info->getType() == zim::ZIMTipsMessageChangeInfoType::ZIM_TIPS_MESSAGE_CHANGE_INFO_TYPE_GROUP_DATA_CHANGED) {
                    if (info->getGroupDataFlag() & ZIM_GROUP_DATA_FLAG_NAME) {
                        // 群名变更
                        auto new_group_name = info->getGroupName();
                    }

                    if (info->getGroupDataFlag() & ZIM_GROUP_DATA_FLAG_NOTICE) {
                        // 群公告变更
                        auto new_group_notice = info->getGroupNotice();
                    }

                    if (info->getGroupDataFlag() & ZIM_GROUP_DATA_FLAG_AVATAR_URL) {
                        // 群头像变更
                        auto new_group_avatar_url = info->getGroupAvatarUrl();
                    }
                }

                ......// 业务逻辑
            } else if (tips_message->getEvent() == zim::ZIMTipsMessageEvent::ZIM_TIPS_MESSAGE_EVENT_GROUP_MEMBER_INFO_CHANGED) {
                // 如果 Tips 消息类型为群成员变更。
                auto info = std::static_pointer_cast<zim::ZIMTipsMessageGroupMemberChangeInfo>(tips_message->getChangeInfo());
                ......// 业务逻辑
            }
            ......
        }
    }

}

Copied!

3 展示消息

根据以上获取到的 Tips 消息，根据以上获取的信息，开发者需要自行生成对应事件的字符串并在 App UI 上展示该文本。