Manage chat group member attributes

Chat groups enable real-time messaging among multiple users.

This page shows how to use the Agora Chat SDK to manage the attributes of the members of a chat group in your app.

Understand the tech

The Chat SDK provides the Group, GroupManager, and GroupChangeListener classes for chat group management, which allows you to implement the following features:

Set custom attributes of a group member via key and value items.
Fetch group member custom attributes.
Listen for attribute changes of a group member.

Prerequisites

Before proceeding, ensure that you meet the following requirements:

You have initialized the Chat SDK. For details, SDK quickstart.
You understand the call frequency limits of the Chat APIs supported by different pricing plans as described in Limitations.
You understand the number of chat groups and chat group members supported by different pricing plans as described in Pricing Plan Details.

Implementation

This section describes how to call the APIs provided by the Chat SDK to implement chat group features.

Set custom attributes of a group member via key and value items

Each chat group member can set their own attributes. Chat group admins/owners can also modify all members' attributes. Each custom attribute should be in key-value format.

Refer to the following sample code to set a custom attribute of a group member:

Map<String,String> attributeMap = new HashMap<>();
attributeMap.put("nickName",nickName);
ChatClient.getInstance().groupManager().asyncSetGroupMemberAttributes(groupId, userId, attributeMap, new CallBack() {
    @Override
    public void onSuccess() {
    }
    @Override
    public void onError(int code, String error) {
    }
});

Fetch group member custom attributes

Chat group members and group admins/owners can retrieve custom attributes of multiple group members by attribute key.

Refer to the following sample code to use the attribute key to fetch custom attributes of multiple group members:

List<String> keyList = new ArrayList<>();
keyList.add("nickName");
List<String> userIds = new ArrayList<>();
userIds.add("Tom");
userIds.add("Jack");
ChatClient.getInstance().groupManager().asyncFetchGroupMembersAttributes(groupId, userIds, keyList, new ValueCallBack<Map<String, Map<String, String>>>() {
    @Override
    public void onSuccess(Map<String, Map<String, String>> value) {
        if (value != null){
            for (String user : userIds) {
                Map<String,String> map = value.get(user);
                if (map != null){
                   //……
                }
            }
        }
    }
    @Override
    public void onError(int code, String error) {
    }
});

Listen for attribute changes of a group member

GroupChangeListener class holds callbacks that can be used to monitor the change of any key-value items. When such a change occurs, an onGroupMemberAttributeChanged callback will notify the Client SDK by returning chat group ID, UID, and key-value pairs of the changes.

//Create a GroupChangeListener object
GroupChangeListener groupChangeListener = new GroupChangeListener() {
    @Override
    public void onGroupMemberAttributeChanged(String groupId, String userId, Map<String, String> attribute, String from) {
        if ( attribute != null && attribute.size() > 0){
            //EMLog.d(TAG,"onGroupMemberAttributeChanged: " + groupId +" - "+ attribute.toString());
        }
    }
};
//Add a group change listener:
ChatClient.getInstance().groupManager().addGroupChangeListener(groupChangeListener);
//Remove a group change listener:
ChatClient.getInstance().groupManager().removeGroupChangeListener(groupChangeListener);

Understand the tech​

Prerequisites​

Implementation​

Set custom attributes of a group member via key and value items​

Fetch group member custom attributes​