Group Profile
Feature Description
Getting the Group Profile
Call
GroupGetGroupInfoList
(Details) to get the group profile. This API supports passing in multiple group_id_list
values at a time to batch get group profiles.Sample code:
// Get the group profileTIMResult res = TencentIMSDK.GroupGetGroupInfoList(group_id_list, TIMReceiveMessageOpt.kTIMRecvMsgOpt_Not_Receive, (int code, string desc, List<GetGroupInfoResult> result, string user_data)=>{// Process the async logic});
Modifying the Group Profile
If you have called
SetGroupTipsEventCallback
(Details) to add a group event listener, after the group profile is modified, all the group members will receive the callback data.Member roles that can modify the group profile vary by group type as follows:
Group Type | Member Roles Allowed to Modify the Basic Group Profile |
Work group (Work) | All group members |
Public group (Public) | Group owner and admin |
Meeting group (Meeting) | Group owner and admin |
Community (Community) | Group owner and admin |
Audio-video group (AVChatRoom) | Group owner |
Sample code:
GroupModifyInfoParam param = new GroupModifyInfoParam{group_modify_info_param_group_id = "group_id",group_modify_info_param_modify_flag = TIMGroupModifyInfoFlag.kTIMGroupModifyInfoFlag_Name, // Rename a groupgroup_modify_info_param_group_name = "new group name"};TIMResult res = TencentIMSDK.GroupModifyGroupInfo(param, (int code, string desc, string user_data)=>{// Process the async logic});
Setting the Group Message Receiving Option
Any group member can call the
MsgSetGroupReceiveMessageOpt
API (Details) to change the group message receiving option.TIMReceiveMessageOpt
has the following options:Message Receiving Option | Description |
TIMReceiveMessageOpt.kTIMRecvMsgOpt_Receive | Messages will be received when the user is online, and push notifications will be received when the user is offline. |
TIMReceiveMessageOpt.kTIMRecvMsgOpt_Not_Receive | No group messages will be received. |
TIMReceiveMessageOpt.kTIMRecvMsgOpt_Not_Notify | Messages will be received when the user is online, and no push notifications will be received when the user is offline. |
Different
TIMReceiveMessageOpt
options can be used to implement group message notification muting:No group messages will be received.
After the group message receiving option is set to
kTIMRecvMsgOpt_Not_Receive
, no group messages will be received, and the conversation list will not be updated.Group messages will be received but will not be notified to the user, and a badge without the unread count will be displayed on the conversation list UI.
1. The group message receiving option is set to
kTIMRecvMsgOpt_Not_Notify
.2. When the receiver receives a new group message and needs to update the conversation list, it can get the unread count through
conv_unread_num
(Details) in ConvInfo
of the conversation.3. The receiver displays a badge rather than the unread count when identifying the message receiving option as
kTIMRecvMsgOpt_Not_Notify
based on the conv_recv_opt
(Details) in ConvInfo
.Note:
As this method requires the unread count feature, it applies only to work groups (Work) and public groups (Public).
Sample code:
// Set the group message receiving optionGroupModifyInfoParam param = new GroupModifyInfoParam{group_modify_info_param_group_id = "group_id",group_modify_info_param_modify_flag = TIMGroupModifyInfoFlag.kTIMGroupModifyInfoFlag_AddOption, // Change the group join optiongroup_modify_info_param_add_option = TIMGroupAddOption.kTIMGroupAddOpt_Auth};TIMResult res = TencentIMSDK.GroupModifyGroupInfo(param, (int code, string desc, string user_data)=>{// Process the async logic});