群组管理

概述

把多个 username 加入到同一个群组内，在群组内发送群组消息。

  • 创建私有群组、创建公开群组（2.4.0版本新增公开群组）
  • 加入，退出群组；
  • 加群组成员、移除群组成员；
  • 群组管理员
  • 申请加入和审批
  • 禁言、消息屏蔽
  • 群@功能

创建群组

群组分为私有群组、公开群组。

  • 私有群组无法申请加入，群内成员邀请即可加入。
  • 公开群组可通过获取公开群组列表获取。
  • 公开群组可通过发起加入申请，群主或管理员审核通过的方式加入。
  • 公开群组群主或管理员直接邀请即可加入，群成员邀请入群需群主或管理员审批。

创建私有群组

  1. JMessageClient.createGroup(String groupName, String groupDesc, CreateGroupCallback callback);
  3. @since 2.3.0
  4. JMessageClient.createGroup(String groupName, String groupDesc, File groupAvatarFile, String format, CreateGroupCallback callback);

参数说明

  • String groupName 群名称
  • String groupDesc 群描述
  • File groupAvatarFile 群头像文件
  • String format 头像文件扩展名，注意名称中不要包括”.”
  • CreateGroupCallback callback 结果回调

回调

  1.   public abstract void gotResult(int responseCode, String responseMsg, long groupId);
  • long groupId 新创建成功的群组ID（resopnseCode = 0 时）。

创建公开群组

Since 2.4.0
2.4.0版本新增公开群组类型。公开群组可通过入群申请，经群主或管理员审核通过的方式加入。公开群组群主或管理员直接邀请即可加入。群成员邀请入群需群主或管理员审批 。

  1.     /**
  2.      * 创建公开群组, 群组创建成功后，创建者会默认包含在群成员中。
  3.      * 公开群组与私有群组的区别是公开群组只有群主和管理员邀请入群才能直接入群，群内其他人员邀请他人入群需要经过群主或管理员审批，
  4.      * 管理员相关见{@link GroupInfo#addGroupKeeper(List, BasicCallback)}, 同时公开群组支持申请入群操作{@link JMessageClient#applyJoinGroup(long, String, BasicCallback)},
  5.      * 申请入群时也需要群主或管理员审批, 需要审批入群时群主和管理员会收到{@link cn.jpush.im.android.api.event.GroupApprovalEvent}事件
  6.      * 通过{@link GroupInfo#getGroupType()}得到群组类型
  7.      *
  8.      * @param groupName 群组名称
  9.      * @param groupDesc 群组描述
  10.      * @param callback  回调接口
  11.      * @since 2.4.0
  12.      */
  13.     JMessageClient.createPublicGroup(String groupName, String groupDesc,
  14.                                              CreateGroupCallback callback);
  16.     /**
  17.      * 创建公开群组，群组创建成功后，创建者会默认包含在群成员中。
  18.      * 公开群组定义参考{@link JMessageClient#createPublicGroup(String, String, CreateGroupCallback)}
  19.      * 使用此接口创建群组时可以指定群头像,并且可以指定头像文件在后台存储时的扩展名，如果填空或者不填，则后台存储文件时将没有扩展名。
  20.      *
  21.      * @param groupName       群组名称
  22.      * @param groupDesc       群组描述
  23.      * @param groupAvatarFile 群组头像文件
  24.      * @param format          头像文件扩展名，注意名称中不要包括"."
  25.      * @param callback        回调接口
  26.      * @since 2.4.0
  27.      */
  28.     JMessageClient.createPublicGroup(final String groupName, final String groupDesc, final File groupAvatarFile, String format,
  29.                                              final CreateGroupCallback callback);

解散群组

Since 2.5.0

  1.     /**
  2.      * 解散指定的群组，只有群的群主有权限解散。
  3.      * 群组解散后会以message的形式通知到群内所有成员，类型为{@link cn.jpush.im.android.api.content.EventNotificationContent.EventNotificationType#group_dissolved}
  4.      *
  5.      * @param groupID 群组id
  6.      * @param callback 回调
  7.      * @since 2.5.0
  8.      */
  9.     JMessageClient.adminDissolveGroup(long groupID, BasicCallback callback);

群组信息

获取群组列表

  1. JMessageClient.getGroupIDList(GetGroupIDListCallback callback)

回调

  1. public abstract void gotResult(int responseCode, String responseMessage,
  2.             List<Long> groupIDList)
  • List<Long> groupIDList 当前用户所加入的群组的groupID的list

获取公开群组列表

Since 2.4.1

可获取指定appkey所属下公开群组基本信息

  1.     /**
  2.      * 获取指定应用appKey所属下公开群组基本信息, 如果appKey为空则默认使用本应用appKey.
  3.      * 公开群组定义见{@link JMessageClient#createPublicGroup(String, String, CreateGroupCallback)}，
  4.      * 群基本信息定义见{@link GroupBasicInfo}
  5.      *
  6.      * @param appKey   指定应用的appKey
  7.      * @param start    起始位置
  8.      * @param count    获取个数
  9.      * @param callback 接口回调
  10.      * @since 2.4.1
  11.      */
  12.     JMessageClient.getPublicGroupListByApp(String appKey, int start, int count, RequestCallback<List<GroupBasicInfo>> callback);

代码示例

  1. //获取指定应用下所有公开群组
  2. JMessageClient.getPublicGroupListByApp(appkey, start, count, new RequestCallback<List<GroupBasicInfo>>() {
  3.     @Override
  4.     public void gotResult(int responseCode, String responseMessage, List<GroupBasicInfo> groupBasicInfos) {
  5.         if (responseCode == 0) {
  6.             String result = "";
  7.             for (GroupBasicInfo groupBasicInfo : groupBasicInfos) {
  8.                 result += "GroupID: " + groupBasicInfo.getGroupID() + ", GroupType: " + groupBasicInfo.getGroupType() +
  9.                         ", GroupName: " + groupBasicInfo.getGroupName() + ", GroupDescription: " + groupBasicInfo.getGroupDescription() +
  10.                         ", GroupAvatarMediaID: " + groupBasicInfo.getAvatar() + ", GroupMaxMemberCount: " + groupBasicInfo.getMaxMemberCount()+ "\n\n";
  11.             }
  12.             tvDisplay.setText(result);
  13.             tvDisplay.post(new Runnable() {
  14.                 @Override
  15.                 public void run() {
  16.                     scrollView.fullScroll(ScrollView.FOCUS_DOWN);
  17.                 }
  18.             });
  19.         } else {
  20.             tvDisplay.setText("获取失败!\nresponseCode:" + responseCode + "\nresponseMsg" + responseMessage);
  21.         }
  22.     }
  23. });

获取群组信息

  1. JMessageClient.getGroupInfo(long groupId, GetGroupInfoCallback callback)

参数说明

  • long groupId 群ID
  • GetGroupInfoCallback callback 结果回调

回调

  1.   public void gotResult(int responseCode, String responseMessage, GroupInfo groupInfo)
  • GroupInfo groupInfo 返回的群组信息对象

更新群组名称

  1. groupInfo.updateName(String groupName, BasicCallback callback);

参数说明

  • String groupName 新的名称
  • BasicCallback callback 结果回调

更新群组描述

  1. groupInfo.updateDescription(String groupDesc, BasicCallback callback);

参数说明

  • String groupName 新的群组详情描述
  • BasicCallback callback 结果回调

更新群组头像

Since 2.3.0

  1. groupInfo.updateAvatar(File avatar, String format, BasicCallback callback);

参数说明

  • File avatar 群头像文件
  • String format 文件扩展名，注意名称中不要包含“.”
  • BasicCallback callback 结果回调

修改群组类型

Since 2.6.1

  1. groupInfo.changeGroupType(Type type, BasicCallback callback);

参数说明

  • Type type 群组类型
  • BasicCallback callback 结果回调

群成员信息

获取群组成员列表

  1. JMessageClient.getGroupMembers(long groupID,
  2.       RequestCallback<List<GroupMemberInfo>> callback)

参数说明

  • long groupId 群组ID
  • RequestCallback callback

回调

  1.   public void gotResult(int responseCode, String responseMessage, List<GroupMemberInfo> members);
  • List GroupMemberInfos 成员列表(GroupMemberInfo)。

群成员信息

群成员信息实体类 GroupMemberInfo
Since 2.7.0

方法 类型 说明
getType() Type 获取群成员类别：群主，群管理员，普通群成员
isKeepSilence() boolean 群成员在群内是否被禁言 true被禁言，false没有被禁言
getUserInfo() UserInfo 获取群成员对应的用户信息
getNickName() String 获取群成员昵称
getDisplayName() String 获取群成员在群内的展示名，展示名返回优先级为：群昵称>备注名>用户昵称>用户名
getJoinGroupTime() long 获取入群时间，单位豪秒

设置群成员昵称

Since 2.7.0

  1.     /**
  2.      * 修改群成员昵称,群成员仅能修改自己在此群的昵称，管理员或群主修改任何普通群成员在此群的昵称，群成员类型见{@link GroupMemberInfo#type}
  3.      *
  4.      * @param username 群成员用户名
  5.      * @param appKey 群成员appKey,传入空则默认使用本应用appKey
  6.      * @param nickName 昵称
  7.      * @param callback 结果回调
  8.      * @since 2.7.0
  9.      */
  10.     groupInfo.setMemNickname(String username, String appKey, String nickName, BasicCallback callback);

群成员管理

添加群组成员

  1. JMessageClient.addGroupMembers(long groupID, String appKey, List<String> userNameList, BasicCallback callback)

参数说明

  • long groupId 待加群的群组ID。创建群组时返回的。
  • String appkey 被添加的群成员所属的appkey，不填则默认为本应用appkey
  • List usernameList 群组成员列表，使用成员 username。
  • BasicCallback callback 结果回调

添加群组成员,附带reason参数，注意只对公开群组有效

Since 2.6.1

  1. JMessageClient.addGroupMembers(final long groupID, final String appKey, final List<String> userNameList, final String reason, final BasicCallback callback);

参数说明

  • long groupId 待加群的群组ID。创建群组时返回的。
  • String appkey 被添加的群成员所属的appkey，不填则默认为本应用appkey
  • List usernameList 群组成员列表，使用成员 username。
  • String reason 公开群组邀请人入群的理由
  • BasicCallback callback 结果回调

移除群组成员

  1. JMessageClient.removeGroupMembers(long groupId, String appKey, List<String> usernameList, BasicCallback callback);

参数说明

  • long groupId 待删除成员的群ID。
  • String appkey 被移除的群成员所属的appkey，不填则默认为本应用appkey
  • List usernameList 待删除的成员列表。
  • BasicCallback callback 结果回调。

移交群主

Since 2.5.0

  1.     /**
  2.      * 移交群主,将群主移交給指定群内成员,移交群主后原群主成为普通群成员.<br/>
  3.      * 移交群主成功后群内所有成员会收到群主变更事件，SDK收到事件会以类型为{@link cn.jpush.im.android.api.content.EventNotificationContent.EventNotificationType#group_owner_changed}
  4.      * 的消息事件方式上报
  5.      *
  6.      * @param username 待移交者用户名
  7.      * @param appKey 待移交者appKey, 若传入空则默认使用本应用appKey
  8.      * @since 2.5.0
  9.      */
  10.     groupInfo.changeGroupAdmin(String username, String appKey, BasicCallback callback);

退出群组

  1. JMessageClient.exitGroup(long groupId, BasicCallback callback);

参数说明

  • long groupId 待退出的群ID。
  • BasicCallback callback 结果回调。

群组管理员

Since 2.5.0
2.5.0版本新增群组管理员。管理员可以移除、禁言普通群成员，并且在公开群组里可以直接添加群成员和审核入群审批。群主可以添加、取消管理员并且移除或禁言管理员。

添加群管理员

Since 2.5.0 

  1.     /**
  2.      * 添加群管理员
  3.      *
  4.      * @param userInfos 群成员UserInfo列表
  5.      * @param callback 回调
  6.      * @since 2.5.0
  7.      */
  8.     groupInfo.addGroupKeeper(List<UserInfo> userInfos, BasicCallback callback);

取消管理员

Since 2.5.0

  1.     /**
  2.      * 取消群管理员，管理员角色描述详见官方文档<a href="https://docs.jiguang.cn/jmessage/client/im_sdk_android/">群组管理员<a/>
  3.      *
  4.      * @param userInfos 群成员UserInfo列表
  5.      * @param callback 回调
  6.      * @since 2.5.0
  7.      */
  8.     groupInfo.removeGroupKeeper(List<UserInfo> userInfos, BasicCallback callback);

获取管理员列表

Since 2.5.0

  1.     /**
  2.      * 获取群管理员列表, 返回群内管理员的成员信息列表，管理员角色描述详见官方文档<a href="https://docs.jiguang.cn/jmessage/client/im_sdk_android/">群组管理员<a/>
  3.      *
  4.      * @return 管理员的成员信息列表
  5.      * @since 2.5.0
  6.      * @deprecated deprecated in jmessage 2.7.0 use{@link #getGroupKeeperMemberInfos()}instead
  7.      */
  8.     groupInfo.getGroupKeepers();
  10.     /**
  11.      * 获取群管理员列表, 返回群内管理员的成员{@link GroupMemberInfo}列表
  12.      *
  13.      * @return 管理员的成员GroupMemberInfo列表
  14.      * @since 2.7.0
  15.      */
  16.     groupInfo.getGroupKeeperMemberInfos();

代码示例

  1. //添加管理员
  2. groupInfo.addGroupKeeper(userInfos, new BasicCallback() {
  3.     @Override
  4.     public void gotResult(int responseCode, String responseMessage) {
  5.         if (responseCode == 0) {
  6.             Toast.makeText(getApplicationContext(), "添加管理员成功", Toast.LENGTH_SHORT).show();
  7.         } else {
  8.             Toast.makeText(getApplicationContext(), "添加管理员失败", Toast.LENGTH_SHORT).show();
  9.             mTvGroupKeeper.setText("responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  10.         }
  11.     }
  12. });
  14. //取消管理员
  15. groupInfo.removeGroupKeeper(userInfos, new BasicCallback() {
  16.     @Override
  17.     public void gotResult(int responseCode, String responseMessage) {
  18.         if (responseCode == 0) {
  19.             Toast.makeText(getApplicationContext(), "取消管理员成功", Toast.LENGTH_SHORT).show();
  20.         } else {
  21.             Toast.makeText(getApplicationContext(), "取消管理员失败", Toast.LENGTH_SHORT).show();
  22.             mTvGroupKeeper.setText("responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  23.         }
  24.     }
  25. });
  27. //获取管理员列表
  28. List<GroupMemberInfo> memberInfos = groupInfo.getGroupKeeperMemberInfos();
  29. String result = "这里只展示username:";
  30. for (GroupMemberInfo memberInfo : memberInfos) {
  31.     if (memberInfo != null) {
  32.         result += "\n" + memberInfo.getUserInfo().getUserName();
  33.     }
  34. }
  35. mTvGroupKeeper.setText(result);

群消息屏蔽

群组被设置为屏蔽之后，将收不到该群的消息。但是群成员变化事件还是能正常收到
Since 2.1.0

设置群消息屏蔽

  1. groupinfo.setBlockGroupMessage(int blocked, BasicCallback callback)

参数说明

  • int blocked 是否屏蔽群消息。 1 - 屏蔽，0 - 取消屏蔽
  • BasicCallback callback 结果回调。

判断群组是否被屏蔽

  1. groupinfo.isGroupBlocked();

返回

  • int 1 - 已被屏蔽，0 - 未被屏蔽

获取当前用户的群屏蔽列表

  1. JMessageClient.getBlockedGroupsList(GetGroupInfoListCallback callback)

参数说明

  • GetGroupInfoListCallback callback 结果回调。

群组@功能

消息发送方可以发一条带有@list的消息。
接收方收到带有@list的消息之后，如果@list中包含了自己，或者是@全体成员，则在sdk默认弹出的通知栏提示中会有相应的提示，如”xxx在群中@了你”。

创建@群成员的消息

Since 2.1.0 

  1. conversation.createSendMessage(MessageContent content, List<UserInfo> atList, String customFromName)

参数说明

  • MessageContent content 消息内容对象
  • List atList 被@用户的userInfo list
  • String customFromName 自定义fromName

返回

  • Message 消息对象。

创建@全体群成员的消息

Since 2.2.0 

  1. conversation.createSendMessageAtAllMember(MessageContent content, String customFromName)

参数说明

  • MessageContent content 消息内容对象
  • String customFromName 自定义fromName

返回

  • Message 一条包含@全体成员信息的消息对象。

判断消息是否@了自己

Since 2.1.0 

  1. message.isAtMe()

返回

  • boolean true - atList中包含了自己， false - atList中不包含自己

判断消息是否是@全体成员

Since 2.2.0 

  1. message.isAtAll()

返回

  • boolean true - 是@全体成员， false - 不是@全体成员

获取消息中@的群成员列表

Since 2.1.0 

  1. message.getAtUserList(GetUserInfoListCallback callback)

参数说明

  • GetUserInfoListCallback callback 获取用户列表的回调接口。注意当这条消息是一条@全体成员的消息时，此接口将返回空。

代码示例

  1.     //消息发送方
  2.     Conversation conv = Conversation.createGroupConversation(gid);
  3.     GroupInfo groupInfo = (GroupInfo) conv.getTargetInfo();
  4.     List<UserInfo> atList = new ArrayList<UserInfo>();
  5.     atList.add(groupInfo.getGroupMember("user1", appkey).getUserInfo());//获取到被@的群成员的userinfo，并填充到atList中去。
  6.     atList.add(groupInfo.getGroupMember("user2", appkey).getUserInfo());
  8.     //创建一条带有atList的消息。
  9.     Message msg = conv.createSendMessage(new TextContent("a message with atList!"), atList, null);
  10.     JMessageClient.sendMessage(msg);//发送消息
  14.     //消息接收方
  15.     public void onEvent(MessageEvent event){
  16.         Message msg = event.getMessage();//收到消息事件，从消息事件中拿到消息对象
  17.         msg.isAtMe(); //判断这条消息是否@了我
  19.         //获取消息中包含的完整的atList
  20.         msg.getAtUserList(new GetUserInfoListCallback() {
  21.             @Override
  22.             public void gotResult(int responseCode, String responseMessage, List<UserInfo> userInfoList) {
  23.                 if(responseCode == 0){
  24.                     //获取atList成功
  25.                 }else{
  26.                     //获取atList失败
  27.                 }
  28.             }
  29.       });
  30.     }

入群申请和审批

申请入群和审批，适用于公开群组。

申请入群

Since 2.4.0 

  1.     /**
  2.      * 申请加入群组，只有公开群组(公开群组定义参考{@link JMessageClient#createPublicGroup(String, String, CreateGroupCallback)}),
  3.      * 才能发送入群申请
  4.      *
  5.      * @param groupID  申请加入群组的gid
  6.      * @param reason   申请理由，可为null
  7.      * @param callback
  8.      * @since 2.4.0
  9.      */
  10.     JMessageClient.applyJoinGroup(long groupID, String reason, BasicCallback callback);

群成员审批事件

Since 2.4.0 

  1. GroupApprovalEvent

群成员审批事件，收到群成员审批通知时，sdk将会抛出此事件通知上层。 具体处理方法见事件处理一节。

已审批事件通知

Since 2.5.0

  1. GroupApprovedNotificationEvent

群成员审批事件已经被审批通知事件，当有一个群管理员或群主审批过群成员审批事件，sdk将会抛出此事件通知上层, 只有该审批事件对应群的群主和群管理员会收到此事件。具体处理方法见事件处理一节

入群审批

Since 2.4.0
通过接收到的群成员审批事件进行审批操作,审批不能多人操作，当一人同意或拒绝后其他管理者或群主收到已审批事件通知

  1.     /**
  2.      * 入群审批同意，操作成功后，群内所有成员包括被审批人自己都会收到一个包含群成员变化的EventNotification类型的消息
  3.      *
  4.      * @param username 被同意加入群组用户的username
  5.      * @param appKey 被同意入群者的appKey，若传入空则默认使用本应用的appKey
  6.      * @param callback 操作结果回调
  7.      */
  8.     groupApprovalEvent.acceptGroupApproval(String username, String appKey, final BasicCallback callback);
  10.     /**
  11.      * 入群审批拒绝，操作成功后，该次审批请求的发起方(Type为{@link Type#apply_join_group}时是申请人 Type为{@link Type#invited_into_group}时是邀请人)
  12.      * 会收到一个审批拒绝通知事件{@link GroupApprovalRefuseEvent}
  13.      *
  14.      * @param username 被拒绝加入群组用户的username
  15.      * @param appKey 被拒绝入群者的appKey, 若传入空则默认使用本应用的appKey
  16.      * @param reason 拒绝理由，可填null
  17.      * @param callback 操作结果回调
  18.      */
  19.     groupApprovalEvent.refuseGroupApproval(String username, String appKey, String reason, BasicCallback callback);

入群审批审批事件批量同意

Since 2.6.1

  2.     /**
  3.      * 批量同意审批事件内所有成员进群.
  4.      * <p>
  5.      * 操作成功后，事件GroupApprovalEvent对象内包含的所有待审批的用户都会被批准入群。之后，
  6.      * 群内所有成员包括被审批人自己都会收到一个包含群成员变化的EventNotification类型的消息
  7.      *
  8.      * @param events     待处理的事件对象集合
  9.      * @param sendNotify 预留字段，暂时无用
  10.      * @param callback   操作结果回调
  11.      * @since 2.6.1
  12.      */
  13.     GroupApprovalEvent.acceptGroupApprovalInBatch(Collection<GroupApprovalEvent> events, boolean sendNotify, BasicCallback callback);

群成员审批拒绝事件

Since 2.4.0 

  1. GroupApprovalRefuseEvent

群成员审批拒绝通知事件，收到群成员审批拒绝通知时，sdk将会抛出此事件通知上层，具体处理方法见事件处理一节

入群审批代码示例：

  1. //申请入群
  2. JMessageClient.applyJoinGroup(Long.parseLong(mEt_groupID.getText().toString()), reason, new BasicCallback() {
  3.     @Override
  4.     public void gotResult(int responseCode, String responseMessage) {
  5.         mProgressDialog.dismiss();
  6.         if (responseCode == 0) {
  7.             Toast.makeText(ApplyJoinGroupActivity.this, "申请成功", Toast.LENGTH_SHORT).show();
  8.         } else {
  9.             Log.d(TAG, "apply failed. code :" + responseCode + " msg : " + responseMessage);
  10.             Toast.makeText(ApplyJoinGroupActivity.this, "申请失败", Toast.LENGTH_SHORT).show();
  11.         }
  12.     }
  13. });
  15. //入群审批
  16. event.acceptGroupApproval(username, appKey, new BasicCallback() {
  17.     @Override
  18.     public void gotResult(int responseCode, String responseMessage) {
  19.         if (0 == responseCode) {
  20.             Toast.makeText(getApplicationContext(), "添加成功", Toast.LENGTH_SHORT).show();
  21.         } else {
  22.             Log.i(TAG, "acceptApplyJoinGroup failed,"+ " code = " + responseCode + ";msg = " + responseMessage);
  23.             Toast.makeText(getApplicationContext(), "添加失败", Toast.LENGTH_SHORT).show();
  24.         }
  25.     }
  26. }); //入群审批同意
  28. event.refuseGroupApproval(username, appKey, reason, new BasicCallback() {
  29.     @Override
  30.     public void gotResult(int responseCode, String responseMessage) {
  31.         if (0 == responseCode) {
  32.             Toast.makeText(getApplicationContext(), "拒绝成功", Toast.LENGTH_SHORT).show();
  33.         } else {
  34.             Log.i(TAG, "refuseApplyJoinGroup failed,"+ " code = " + responseCode + ";msg = " + responseMessage);
  35.             Toast.makeText(getApplicationContext(), "拒绝失败", Toast.LENGTH_SHORT).show();
  36.         }
  37.     }
  38. }); //入群审批拒绝
  40. GroupApprovalEvent.acceptGroupApprovalInBatch(events, false, new BasicCallback() {
  41.     @Override
  42.     public void gotResult(int responseCode, String responseMessage) {
  43.         textView.append("批量审批请求发送完成。 responseCode = " + responseCode + " responseMessage = " + responseMessage + "\n");
  44.         scrollView.fullScroll(ScrollView.FOCUS_DOWN);
  45.         events.clear();
  46.     }
  47. }); // 入群审批批量同意

群成员禁言

Since 2.4.0
2.4.0版本新增群成员禁言状态设置,禁言后用户可正常接收消息，但无法向被禁言的群组中发送消息，解禁后可正常发送消息。 2.4.0老接口废弃，请使用2.8.2新接口

群成员禁言状态设置

Since 2.8.2

  1.     /**
  2.      * 设置群成员禁言（可设置禁言时间,批量设置一次最多500个）,群主和管理员可以禁言普通群成员,
  3.      * 群主和管理员不能被禁言，重复调用此接口将根据当前时间重新计算结束时间。
  4.      * 禁言后用户可正常接收消息，但无法向被禁言的群组中发送消息,禁言成功后会以系统消息形式通知群内成员
  5.      * @param userInfos 将要被禁言的用户信息，size <= 500
  6.      * @param silenceTime 禁言时间，单位：毫秒， 禁言时间最少5分钟（300000毫秒），最长一年（31536000000毫秒),即300000 <= times <= 31536000000
  7.      * @param callback 禁言结果回调
  8.      * @since 2.8.2
  9.      */
  10.     groupInfo.addGroupSilenceWithTime(Collection<UserInfo> userInfos, long silenceTime, BasicCallback callback);

获取禁言列表

Since 2.8.2

  1.     /**
  2.      * 获取群禁言列表,排序规则以添加入禁言的先后的时间倒序排序（后加入的在前）
  3.      * @param callback 结果回调
  4.      * @since 2.8.2
  5.      */
  6.     groupInfo.getGroupSilenceList(RequestCallback<List<SilenceInfo>> callback);

查询用户禁言状态

Since 2.8.2

  1.     /**
  2.      * 查询群内用户的禁言状态，如果用户未处于禁言状态，回调中SilenceInfo为null
  3.      * @param name 群成员的username
  4.      * @param appkey 群成员的appKey，传入空则默认使用本应用appKey
  5.      * @param callback 回调，如果用户未处于禁言状态，回调中SilenceInfo为null
  6.      * @since 2.8.2
  7.      *
  8.      */
  9.     groupInfo.getGroupMemberSilence(String name, String appkey, RequestCallback<SilenceInfo> callback);

群成员禁言相关代码示例

  1. //设置群成员禁言状态
  2. GroupMemberInfo memberInfo = groupInfo.getGroupMember(mNames, mAppKey);
  3. UserInfo userInfo = memberInfo != null ? memberInfo.getUserInfo() : null;
  4. if (userInfo != null) {
  5.     List<UserInfo> userInfos = Collections.singletonList(userInfo);
  6.     SetSilenceCallback callback = new SetSilenceCallback(keepSilence);
  7.     if (keepSilence) {
  8.         groupInfo.addGroupSilenceWithTime(userInfos, silenceTime, callback);
  9.     } else {
  10.         groupInfo.delGroupSilence(userInfos, callback);
  11.     }
  12. } else {
  13.     mProgressDialog.dismiss();
  14.     Toast.makeText(getApplicationContext(), "用户信息获取失败", Toast.LENGTH_SHORT).show();
  15. }
  17. //获取群成员禁言列表
  18. groupInfo.getGroupSilenceList(new RequestCallback<List<SilenceInfo>>() {
  19.         @Override
  20.         public void gotResult(int responseCode, String responseMessage, List<SilenceInfo> result) {
  21.             if (0 == responseCode) {
  22.                 StringBuilder sb = new StringBuilder();
  23.                 for (SilenceInfo silenceInfo : result) {
  24.                     sb.append(silenceInfo.getUserInfo().getUserName())
  25.                             .append(", begin:" + silenceInfo.getSilenceStartTime())
  26.                             .append(", end:" + silenceInfo.getSilenceEndTime())
  27.                             .append("\n");
  28.                 }
  29.                 mTv_showSilenceInfo.append("群成员禁言信息列表(这里获取name,需要其他信息请自行获取)：\n" + sb.toString());
  30.                 Toast.makeText(getApplicationContext(), "获取成功", Toast.LENGTH_SHORT).show();
  31.             } else {
  32.                 Log.i(TAG, "getGroupSilenceList" + ", responseCode = " + responseCode + " ; Desc = " + responseMessage);
  33.                 Toast.makeText(getApplicationContext(), "获取失败", Toast.LENGTH_SHORT).show();
  34.             }
  35.         }
  36.     });
  38. //获取用户禁言状态
  39. groupInfo.getGroupMemberSilence(mNames, mAppKey, new RequestCallback<SilenceInfo>() {
  40.     @Override
  41.     public void gotResult(int responseCode, String responseMessage, SilenceInfo result) {
  42.         mProgressDialog.dismiss();
  43.         if (responseCode == 0) {
  44.             StringBuilder stringBuilder = new StringBuilder();
  45.             stringBuilder.append("用户:" + mNames);
  46.             if (result == null) {
  47.                 stringBuilder.append(", 没有被禁言");
  48.             } else {
  49.                 stringBuilder.append(", 已被禁言\n")
  50.                         .append("禁言开始时间:").append(result.getSilenceStartTime()).append("\n")
  51.                         .append("禁言结束时间：").append(result.getSilenceEndTime()).append("\n");
  52.             }
  53.             mTv_showSilenceInfo.setText(stringBuilder);
  54.         } else {
  55.             Log.i(TAG, "getGroupMemberSilence" + ", responseCode = " + responseCode + " ; Desc = " + responseMessage);
  56.             Toast.makeText(getApplicationContext(), "获取失败", Toast.LENGTH_SHORT).show();
  57.         }
  58.     }
  59. });

群公告

发布群公告

Since 2.8.0 

  1.     /**
  2.      * 发布群公告（只有群主和管理员有权限发送），选择是否向群中发布消息，sendMessage为true代表发送，false不发送<br/>
  3.      * 注意只有发送公告成功时才会向群中发布消息，创建的消息在回调中返回，如果发送公告失败或者创建消息失败则回调中message为null。<br/>
  4.      * 消息的发送是否成功可以通过{@link cn.jpush.im.android.api.enums.MessageStatus}判断,
  5.      * <p>Message的extra里带有公告的实现，key为""jmessage_group_announcement"， value为jsonString:
  6.      * <pre>
  7.      * {"id": 公告id,"text":"公告内容text,"publisher_uid"：发布者uid,"ctime" : 公告发布时间,"gid":群组id}
  8.      * <pre/>
  9.      * 获取方式如下:
  10.      * <pre>
  11.      * String announceJson = message.getContent.getStringExtras("jmessage_group_announcement");
  12.      * </pre></p>
  13.      * 可自己通过字段去解析json字符串，也可通过{@link GroupAnnouncement#fromJson(String)}得到公告对象
  14.      * 如果needSendMessage为false, 回调中message一直为null。<br/>
  15.      * 群公告最多100条，超过老的将会被删除，发布群公告成功时群内所有人会收到{@link cn.jpush.im.android.api.event.GroupAnnouncementChangedEvent}
  16.      * @param text 公告内容字节数不能超过1K(utf-8)
  17.      * @param needSendMessage 是否需要发送消息
  18.      * @param callback PublishAnnouncementCallback 回调中包含创建的公告和消息
  19.      * @since 2.8.0
  20.      */
  21.     groupInfo.publishGroupAnnouncement(String text, Boolean needSendMessage, PublishAnnouncementCallback callback);

获取群公告

Since 2.8.0 

  1.     /**
  2.      * 按照顺序(置顶时间倒序，创建时间倒序)获取群内所有公告.<br/>
  3.      *
  4.      * @param callback 回调,如果获取成功但群没有公告则返回一个empty list
  5.      * @since 2.8.0
  6.      */
  7.     groupInfo.getAnnouncementsByOrder(RequestCallback<List<GroupAnnouncement>> callback);

删除群公告

Since 2.8.0 

  1.     /**
  2.      * 删除群内指定id的公告，只有群主和管理员有权限删除<br/>
  3.      * 删除群公告成功时群内所有成员会收到{@link cn.jpush.im.android.api.event.GroupAnnouncementChangedEvent}
  4.      *
  5.      * @param announceID 公告id 通过{@link GroupAnnouncement#getAnnounceID()}获取
  6.      * @param callback 回调
  7.      * @since 2.8.0
  8.      */
  9.     groupInfo.delGroupAnnouncement(int announceID, BasicCallback callback);

置顶群公告

Since 2.8.0 

  1.     /**
  2.      * 设置置顶状态,本设置为改变置顶状态和置顶时间，同时会导致公告的排序发生改变{@link #getAnnouncementsByOrder(RequestCallback)}<br/>
  3.      * 设置成功时，群内所有成员会收到{@link cn.jpush.im.android.api.event.GroupAnnouncementChangedEvent}
  4.      *
  5.      * @param announceID 公告id, 通过{@link GroupAnnouncement#getAnnounceID()}获取
  6.      * @param isTop true置顶， false取消置顶
  7.      * @param callback 回调
  8.      * @since 2.8.0
  9.      */
  10. groupInfo.setTopAnnouncement(int announceID, boolean isTop, BasicCallback callback);

群公告相关代码示例

  1. // 发布群公告
  2. String text = mEtText.getText().toString();
  3. boolean needSendMessage = Boolean.valueOf(mEtSendMessage.getText().toString());
  4. groupInfo.publishGroupAnnouncement(text, needSendMessage, new PublishAnnouncementCallback() {
  5.     @Override
  6.     public void gotResult(int responseCode, String responseMessage, GroupAnnouncement announcement, Message message) {
  7.         if (ErrorCode.NO_ERROR == responseCode) {
  8.             Toast.makeText(getApplicationContext(), "发布公告成功", Toast.LENGTH_SHORT).show();
  9.         } else {
  10.             Toast.makeText(getApplicationContext(), "发布公告失败", Toast.LENGTH_SHORT).show();
  11.             mTvResult.setText("responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  12.         }
  13.     }
  14. });
  16. // 获取群公告
  17. groupInfo.getAnnouncementsByOrder(new RequestCallback<List<GroupAnnouncement>>() {
  18.     @Override
  19.     public void gotResult(int responseCode, String responseMessage, List<GroupAnnouncement> announcements) {
  20.         if (ErrorCode.NO_ERROR == responseCode) {
  21.             StringBuilder result = new StringBuilder();
  22.             for (GroupAnnouncement announcement : announcements) {
  23.                 result.append("公告ID:" + announcement.getAnnounceID() + "\n");
  24.                 result.append("公告内容:" + announcement.getText() + "\n");
  25.                 result.append("公告创建时间:" + announcement.getCtime() + "\n");
  26.                 result.append("公告是否置顶:" + announcement.isTop() + "\n");
  27.                 result.append("公告置顶时间:" + announcement.getTopTime() + "\n");
  28.                 result.append("公告发布者(username):" + announcement.getPublisher().getUserName() + "\n\n");
  29.             }
  30.             Toast.makeText(getApplicationContext(), "获取公告成功", Toast.LENGTH_SHORT).show();
  31.             mTvResult.setText(result.toString());
  32.         } else {
  33.             Toast.makeText(getApplicationContext(), "获取公告失败", Toast.LENGTH_SHORT).show();
  34.             mTvResult.setText("responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  35.         }
  36.     }
  37. });
  39. // 删除群公告
  40. try {
  41.     int announceID = Integer.valueOf(mEtAnnounceID.getText().toString());
  42.     groupInfo.delGroupAnnouncement(announceID, new BasicCallback() {
  43.         @Override
  44.         public void gotResult(int responseCode, String responseMessage) {
  45.             if (ErrorCode.NO_ERROR == responseCode) {
  46.                 Toast.makeText(getApplicationContext(), "删除公告成功", Toast.LENGTH_SHORT).show();
  47.             } else {
  48.                 Toast.makeText(getApplicationContext(), "删除公告失败", Toast.LENGTH_SHORT).show();
  49.                 mTvResult.setText("responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  50.             }
  51.         }
  52.     });
  53. } catch (NumberFormatException e) {
  54.     Toast.makeText(getApplicationContext(), "请输入合法公告ID", Toast.LENGTH_SHORT).show();
  55. }
  57. // 置顶群公告
  58. try {
  59.     int announceID = Integer.valueOf(mEtAnnounceID.getText().toString());
  60.     groupInfo.setTopAnnouncement(announceID, isTop, new BasicCallback() {
  61.         @Override
  62.         public void gotResult(int responseCode, String responseMessage) {
  63.             StringBuilder result = new StringBuilder();
  64.             result.append(isTop ? "置顶" : "取消置顶");
  65.             if (ErrorCode.NO_ERROR == responseCode) {
  66.                 result.append("成功");
  67.                 Toast.makeText(getApplicationContext(), result.toString(), Toast.LENGTH_SHORT).show();
  68.             } else {
  69.                 result.append("失败");
  70.                 Toast.makeText(getApplicationContext(), result.toString(), Toast.LENGTH_SHORT).show();
  71.                 mTvResult.setText("responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  72.             }
  73.         }
  74.     });
  75. } catch (NumberFormatException e) {
  76.     Toast.makeText(getApplicationContext(), "请输入合法公告ID", Toast.LENGTH_SHORT).show();
  77. }

群组黑名单

群黑名单用以屏蔽某些不良用户, 被加入黑名单的用户无法再次加入该群组除非从黑名单中移除，如果被加入黑名单的用户已经在群中会被踢出群。

将用户添加至黑名单

Since 2.8.0 

  1.     /**
  2.      * 将用户加到群组黑名单，只有群主和管理员有此权限, 被加入黑名单的用户如果在群内会被踢出群组，黑名单中的用户无法再加入群组<br/>
  3.      * 操作成功后群内成员将收到群黑名单变更事件{@link cn.jpush.im.android.api.event.GroupBlackListChangedEvent}
  4.      *
  5.      * @param userInfos 准备加入黑名单的用户userInfo集合
  6.      * @param callback 回调
  7.      * @since 2.8.0
  8.      */
  9.     groupInfo.addGroupBlacklist(List<UserInfo> userInfos, BasicCallback callback);

将用户从群组黑名单中移除

Since 2.8.0 

  1.     /**
  2.      * 将用户从群组黑名单中移除，只有群主和管理员有此权限.<br/>
  3.      * 操作成功后群内成员将收到群黑名单变更事件{@link cn.jpush.im.android.api.event.GroupBlackListChangedEvent}
  4.      *
  5.      * @param userInfos 准备移出黑名单的用户userInfo集合
  6.      * @param callback 回调
  7.      * @since 2.8.0
  8.      */
  9.     groupInfo.delGroupBlacklist(List<UserInfo> userInfos, BasicCallback callback);

获取群组黑名单用户列表

Since 2.8.0 

  1.     /**
  2.      * 获取群组的黑名单用户列表, 按照被拉黑时间倒序排列
  3.      *
  4.      * @param callback 回调
  5.      * @since 2.8.0
  6.      */
  7.     groupInfo.getGroupBlackList(RequestCallback<List<UserInfo>> callback);

群组黑名单代码相关示例

  1. // 将用户加到群组黑名单
  2. groupInfo.addGroupBlacklist(Collections.singletonList(info), new BasicCallback() {
  3.     @Override
  4.     public void gotResult(int responseCode, String responseMessage) {
  5.         if (ErrorCode.NO_ERROR == responseCode) {
  6.             Toast.makeText(getApplicationContext(), "添加成功", Toast.LENGTH_SHORT).show();
  7.         } else {
  8.             Toast.makeText(getApplicationContext(), "添加失败", Toast.LENGTH_SHORT).show();
  9.             mTvShowResult.setText("添加用户到黑名单失败:\n" + "responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  10.         }
  11.     }
  12. });
  14. // 将用户从群组黑名单中移除
  15. groupInfo.delGroupBlacklist(Collections.singletonList(info), new BasicCallback() {
  16.     @Override
  17.     public void gotResult(int responseCode, String responseMessage) {
  18.         if (ErrorCode.NO_ERROR == responseCode) {
  19.             Toast.makeText(getApplicationContext(), "移除成功", Toast.LENGTH_SHORT).show();
  20.         } else {
  21.             Toast.makeText(getApplicationContext(), "移除失败", Toast.LENGTH_SHORT).show();
  22.             mTvShowResult.setText("将用户从黑名单中移除失败:\n" + "responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  23.         }
  24.     }
  25. });
  27. // 获取群组黑名单用户列表
  28. groupInfo.getGroupBlackList(new RequestCallback<List<UserInfo>>() {
  29.     @Override
  30.     public void gotResult(int responseCode, String responseMessage, List<UserInfo> result) {
  31.         if (ErrorCode.NO_ERROR == responseCode) {
  32.             Toast.makeText(getApplicationContext(), "获取成功", Toast.LENGTH_SHORT).show();
  33.             StringBuilder builder = new StringBuilder();
  34.             if (result.size() > 0) {
  35.                 builder.append("群组黑名单:\n");
  36.                 for (UserInfo userInfo : result) {
  37.                     builder.append("用户名:").append(userInfo.getUserName()).append("\n");
  38.                     builder.append("appKey:").append(userInfo.getAppKey()).append("\n\n");
  39.                 }
  40.             } else {
  41.                 builder.append("群组的黑名单为空");
  42.             }
  43.             mTvShowResult.setText(builder.toString());
  44.         } else {
  45.             Toast.makeText(getApplicationContext(), "获取失败", Toast.LENGTH_SHORT).show();
  46.             mTvShowResult.setText("获取群黑名单失败:\n" + "responseCode:" + responseCode + "\nresponseMessage:" + responseMessage);
  47.         }
  48.     }
  49. });

群组免打扰

群组免打扰参考用户信息管理免打扰设置一节