hyphenate_SDK3.0  3.0.1
hyphenatejavaIMSDK
| Public 成员函数 | 所有成员列表
com.hyphenate.chat.EMGroupManager类 参考

class  EMGroupOptions
 
enum  EMGroupStyle
 

Public 成员函数

List< EMGroupgetAllGroups ()
 
EMGroup getGroup (String groupId)
 
EMGroup createGroup (String groupName, String desc, String[] allMembers, String reason, EMGroupOptions option) throws HyphenateException
 
synchronized void loadAllGroups ()
 
void destroyGroup (final String groupId) throws HyphenateException
 
void addUsersToGroup (String groupId, String[] newmembers) throws HyphenateException
 
void removeUserFromGroup (final String groupId, final String username) throws HyphenateException
 
void leaveGroup (String groupId) throws HyphenateException
 
EMGroup getGroupFromServer (String groupId) throws HyphenateException
 
synchronized List< EMGroupgetJoinedGroupsFromServer () throws HyphenateException
 
EMCursorResult< EMGroupInfogetPublicGroupsFromServer (int pageSize, String cursor) throws HyphenateException
 
void joinGroup (String groupId) throws HyphenateException
 
void changeGroupName (String groupId, String changedGroupName) throws HyphenateException
 
EMGroup acceptInvitation (String groupId, String inviter) throws HyphenateException
 
void declineInvitation (String groupId, String inviter, String reason) throws HyphenateException
 
void acceptApplication (String username, String groupId) throws HyphenateException
 
void declineApplication (String username, String groupId, String reason) throws HyphenateException
 
void setAutoAcceptInvitation (boolean autoAccept)
 
void inviteUser (String groupId, String[] beInvitedUsernames, String reason) throws HyphenateException
 
void applyJoinToGroup (String groupId, String reason) throws HyphenateException
 
void blockGroupMessage (String groupId) throws HyphenateException
 
void unblockGroupMessage (String groupId) throws HyphenateException
 
void blockUser (String groupId, String username) throws HyphenateException
 
void unblockUser (String groupId, String username) throws HyphenateException
 
List< String > getBlockedUsers (String groupId) throws HyphenateException
 
void addGroupChangeListener (EMGroupChangeListener listener)
 
void removeGroupChangeListener (EMGroupChangeListener listener)
 

详细描述

群组管理, 用于管理群组的创建,删除,成员管理等操作

成员函数说明

void com.hyphenate.chat.EMGroupManager.acceptApplication ( String  username,
String  groupId 
) throws HyphenateException

同意加群申请

参数
username申请人username
groupId要申请加入的群id
异常
HyphenateException
EMGroup com.hyphenate.chat.EMGroupManager.acceptInvitation ( String  groupId,
String  inviter 
) throws HyphenateException

接受加入群的邀请

参数
groupId
inviter
返回
用户已经同意邀请的群组对象
void com.hyphenate.chat.EMGroupManager.addGroupChangeListener ( EMGroupChangeListener  listener)

注册群变动事件监听

参数
listener
参见
GroupChangeListener
void com.hyphenate.chat.EMGroupManager.addUsersToGroup ( String  groupId,
String[]  newmembers 
) throws HyphenateException

向群组中添加新的成员

参数
groupId群组的ID
newmembers待添加的新成员用户名
异常
HyphenateException
void com.hyphenate.chat.EMGroupManager.applyJoinToGroup ( String  groupId,
String  reason 
) throws HyphenateException

申请加入某个群(用于加入需要验证的公开群)

参数
groupId
reason申请加入的原因
void com.hyphenate.chat.EMGroupManager.blockGroupMessage ( String  groupId) throws HyphenateException

屏蔽群消息,(还是群里面的成员,但不再接收群消息

参数
groupId
异常
HyphenateException
void com.hyphenate.chat.EMGroupManager.blockUser ( String  groupId,
String  username 
) throws HyphenateException

将用户加到群组的黑名单,被加入黑名单的用户无法加入群,无法收发此群的消息 (只有群主才能设置群的黑名单)

参数
groupId群组的id
username待屏蔽的用户名
异常
HyphenateException出错会抛出
void com.hyphenate.chat.EMGroupManager.changeGroupName ( String  groupId,
String  changedGroupName 
) throws HyphenateException

改变群组的名称(群主才能调用此方法)

参数
groupId需要改变名称的群组的id
changedGroupName改变后的群组名称
异常
HyphenateException
EMGroup com.hyphenate.chat.EMGroupManager.createGroup ( String  groupName,
String  desc,
String[]  allMembers,
String  reason,
EMGroupOptions  option 
) throws HyphenateException

在IM服务器创建一个群组

参数
groupName,群组的名字
allMembers,群成员数组,不需要群主id
reason,邀请群成员加入的信息
options,群的设置
void com.hyphenate.chat.EMGroupManager.declineApplication ( String  username,
String  groupId,
String  reason 
) throws HyphenateException

拒绝加群申请

参数
username申请人username
groupId要申请加入的群id
reason拒绝的理由
异常
HyphenateException
void com.hyphenate.chat.EMGroupManager.declineInvitation ( String  groupId,
String  inviter,
String  reason 
) throws HyphenateException

拒绝加入群的邀请

参数
groupId
inviter
reason,拒绝的原因
返回
用户已经同意邀请的群组对象
void com.hyphenate.chat.EMGroupManager.destroyGroup ( final String  groupId) throws HyphenateException

解散群组 (只有群组的创建者才能调用此函数来删除)

参数
groupId
异常
HyphenateException
List<EMGroup> com.hyphenate.chat.EMGroupManager.getAllGroups ( )

获取当前(内存)用户的所有群组

返回
群组列表
List<String> com.hyphenate.chat.EMGroupManager.getBlockedUsers ( String  groupId) throws HyphenateException

获取群组的黑名单用户列表 (只有群主才能调用此函数) return List<String>

异常
HyphenateException获取失败
EMGroup com.hyphenate.chat.EMGroupManager.getGroup ( String  groupId)

根据群组ID,获得群组对象

参数
groupId群组的ID
返回
群组对象,如果群组不存在,返回null
EMGroup com.hyphenate.chat.EMGroupManager.getGroupFromServer ( String  groupId) throws HyphenateException

从服务器获取群组的详细信息和最新的成员列表

参数
groupId
返回
EMGroup 更新的群组对象
EMCursorResult<EMGroupInfo> com.hyphenate.chat.EMGroupManager.getPublicGroupsFromServer ( int  pageSize,
String  cursor 
) throws HyphenateException

从服务器获取公开群组

参数
pageSize获取多少条
cursor用于分批获取数据的cursor,首次获取数据时传null即可
返回
包含用于下次获取数据的cursor以及群组list的对象
异常
HyphenateException
void com.hyphenate.chat.EMGroupManager.inviteUser ( String  groupId,
String[]  beInvitedUsernames,
String  reason 
) throws HyphenateException

群成员邀请用户加入群组 (如果群组设置成可以成员邀请,现在的群组成员可以邀请其他用户加入)

参数
groupId群组Id
beInvitedUsernames被邀请人username的数组
reason
异常
HyphenateException
void com.hyphenate.chat.EMGroupManager.joinGroup ( String  groupId) throws HyphenateException

当前登录用户加入公开群(如果是自由加入的公开群,直接进入群组;需要验证的公开群需要等待群主同意)

参数
groupId
void com.hyphenate.chat.EMGroupManager.leaveGroup ( String  groupId) throws HyphenateException

当前登录用户退出群组

参数
groupId
异常
HyphenateException
synchronized void com.hyphenate.chat.EMGroupManager.loadAllGroups ( )

同步加载所有群组

void com.hyphenate.chat.EMGroupManager.removeGroupChangeListener ( EMGroupChangeListener  listener)

移除群组变化监听器

参数
listener
void com.hyphenate.chat.EMGroupManager.removeUserFromGroup ( final String  groupId,
final String  username 
) throws HyphenateException

从群组中删除成员

参数
groupId群组的ID
username待删除成员的用户名
异常
HyphenateException
void com.hyphenate.chat.EMGroupManager.setAutoAcceptInvitation ( boolean  autoAccept)

是否自动接受群组邀请 如果设为true,sdk 会对群组邀请自动回复加入

参数
autoAccept
弃用:
use EMOptions.setAutoAcceptGroupInvitation
void com.hyphenate.chat.EMGroupManager.unblockGroupMessage ( String  groupId) throws HyphenateException

取消屏蔽群消息

参数
groupId
异常
HyphenateException
void com.hyphenate.chat.EMGroupManager.unblockUser ( String  groupId,
String  username 
) throws HyphenateException

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

参数
groupId群组的id
username待解除屏蔽的 用户名

该类的文档由以下文件生成: