hyphenate_SDK3.0 3.9.9.2
hyphenate java IM SDK
|
类 | |
enum | EMGroupStyle |
Public 成员函数 | |
List< EMGroup > | getAllGroups () |
EMGroup | getGroup (String groupId) |
EMGroup | createGroup (String groupName, String desc, String[] allMembers, String reason, EMGroupOptions option) throws HyphenateException |
void | asyncCreateGroup (final String groupName, final String desc, final String[] allMembers, final String reason, final EMGroupOptions option, final EMValueCallBack< EMGroup > callback) |
synchronized void | loadAllGroups () |
void | destroyGroup (final String groupId) throws HyphenateException |
void | asyncDestroyGroup (final String groupId, final EMCallBack callback) |
void | addUsersToGroup (String groupId, String[] newmembers) throws HyphenateException |
void | addUsersToGroup (String groupId, String[] newmembers, String welcomeMessage) throws HyphenateException |
void | asyncAddUsersToGroup (final String groupId, final String[] newmembers, final EMCallBack callback) |
void | removeUserFromGroup (final String groupId, final String username) throws HyphenateException |
void | asyncRemoveUserFromGroup (final String groupId, final String username, final EMCallBack callback) |
void | removeUsersFromGroup (final String groupId, final List< String > members) throws HyphenateException |
void | asyncRemoveUsersFromGroup (final String groupId, final List< String > members, final EMCallBack callback) |
void | leaveGroup (String groupId) throws HyphenateException |
void | asyncLeaveGroup (final String groupId, final EMCallBack callback) |
EMGroup | getGroupFromServer (String groupId) throws HyphenateException |
EMGroup | getGroupFromServer (String groupId, boolean fetchMembers) throws HyphenateException |
void | asyncGetGroupFromServer (final String groupId, final EMValueCallBack< EMGroup > callback) |
synchronized List< EMGroup > | getJoinedGroupsFromServer () throws HyphenateException |
synchronized List< EMGroup > | getJoinedGroupsFromServer (int pageIndex, int pageSize) throws HyphenateException |
synchronized List< EMGroup > | getJoinedGroupsFromServer (int pageIndex, int pageSize, boolean needMemberCount, boolean needRole) throws HyphenateException |
void | asyncGetJoinedGroupsFromServer (final EMValueCallBack< List< EMGroup > > callback) |
void | asyncGetJoinedGroupsFromServer (final int pageIndex, final int pageSize, final EMValueCallBack< List< EMGroup > > callback) |
void | asyncGetJoinedGroupsFromServer (final int pageIndex, final int pageSize, boolean needMemberCount, boolean needRole, final EMValueCallBack< List< EMGroup > > callback) |
EMCursorResult< EMGroupInfo > | getPublicGroupsFromServer (int pageSize, String cursor) throws HyphenateException |
void | asyncGetPublicGroupsFromServer (final int pageSize, final String cursor, final EMValueCallBack< EMCursorResult< EMGroupInfo > > callback) |
void | joinGroup (String groupId) throws HyphenateException |
void | asyncJoinGroup (final String groupId, final EMCallBack callback) |
void | changeGroupName (String groupId, String changedGroupName) throws HyphenateException |
void | asyncChangeGroupName (final String groupId, final String changedGroupName, final EMCallBack callback) |
void | changeGroupDescription (String groupId, String changedDescription) throws HyphenateException |
void | asyncChangeGroupDescription (final String groupId, final String changedDescription, final EMCallBack callBack) |
EMGroup | acceptInvitation (String groupId, String inviter) throws HyphenateException |
void | asyncAcceptInvitation (final String groupId, final String inviter, final EMValueCallBack< EMGroup > callback) |
void | declineInvitation (String groupId, String inviter, String reason) throws HyphenateException |
void | asyncDeclineInvitation (final String groupId, final String inviter, final String reason, final EMCallBack callback) |
void | acceptApplication (String username, String groupId) throws HyphenateException |
void | asyncAcceptApplication (final String username, final String groupId, final EMCallBack callback) |
void | declineApplication (String username, String groupId, String reason) throws HyphenateException |
void | asyncDeclineApplication (final String username, final String groupId, final String reason, final EMCallBack callback) |
void | inviteUser (String groupId, String[] beInvitedUsernames, String reason) throws HyphenateException |
void | asyncInviteUser (final String groupId, final String[] beInvitedUsernames, final String reason, final EMCallBack callback) |
void | applyJoinToGroup (String groupId, String reason) throws HyphenateException |
void | asyncApplyJoinToGroup (final String groupId, final String reason, final EMCallBack callback) |
void | blockGroupMessage (String groupId) throws HyphenateException |
void | asyncBlockGroupMessage (final String groupId, final EMCallBack callback) |
void | unblockGroupMessage (String groupId) throws HyphenateException |
void | asyncUnblockGroupMessage (final String groupId, final EMCallBack callback) |
void | blockUser (String groupId, String username) throws HyphenateException |
void | asyncBlockUser (final String groupId, final String username, final EMCallBack callback) |
void | blockUsers (String groupId, List< String > members) throws HyphenateException |
void | asyncBlockUsers (final String groupId, final List< String > members, final EMCallBack callback) |
void | unblockUser (String groupId, String username) throws HyphenateException |
void | asyncUnblockUser (final String groupId, final String username, final EMCallBack callback) |
void | unblockUsers (String groupId, List< String > members) throws HyphenateException |
void | asyncUnblockUsers (final String groupId, final List< String > members, final EMCallBack callback) |
List< String > | getBlockedUsers (String groupId) throws HyphenateException |
List< String > | getBlockedUsers (String groupId, int pageIndex, int pageSize) throws HyphenateException |
void | asyncGetBlockedUsers (final String groupId, final EMValueCallBack< List< String > > callback) |
void | asyncGetBlockedUsers (final String groupId, final int pageIndex, final int pageSize, final EMValueCallBack< List< String > > callback) |
void | addGroupChangeListener (EMGroupChangeListener listener) |
void | removeGroupChangeListener (EMGroupChangeListener listener) |
EMCursorResult< String > | fetchGroupMembers (String groupId, String cursor, int pageSize) throws HyphenateException |
void | asyncFetchGroupMembers (final String groupId, final String cursor, final int pageSize, final EMValueCallBack< EMCursorResult< String > > callback) |
EMGroup | changeOwner (String groupId, String newOwner) throws HyphenateException |
void | asyncChangeOwner (final String groupId, final String newOwner, final EMValueCallBack< EMGroup > callback) |
EMGroup | addGroupAdmin (final String groupId, final String admin) throws HyphenateException |
void | asyncAddGroupAdmin (final String groupId, final String admin, final EMValueCallBack< EMGroup > callback) |
EMGroup | removeGroupAdmin (String groupId, String admin) throws HyphenateException |
void | asyncRemoveGroupAdmin (final String groupId, final String admin, final EMValueCallBack< EMGroup > callback) |
EMGroup | muteGroupMembers (String groupId, List< String > muteMembers, long duration) throws HyphenateException |
void | asyncMuteGroupMembers (final String groupId, final List< String > muteMembers, final long duration, final EMValueCallBack< EMGroup > callback) |
EMGroup | unMuteGroupMembers (String groupId, List< String > members) throws HyphenateException |
void | asyncUnMuteGroupMembers (final String groupId, final List< String > members, final EMValueCallBack< EMGroup > callback) |
Map< String, Long > | fetchGroupMuteList (String groupId, int pageNum, int pageSize) throws HyphenateException |
void | asyncFetchGroupMuteList (final String groupId, final int pageNum, final int pageSize, final EMValueCallBack< Map< String, Long > > callBack) |
List< String > | fetchGroupBlackList (String groupId, int pageNum, int pageSize) throws HyphenateException |
void | asyncFetchGroupBlackList (final String groupId, final int pageNum, final int pageSize, final EMValueCallBack< List< String > > callBack) |
void | addToGroupWhiteList (final String groupId, final List< String > members, final EMCallBack callBack) |
void | removeFromGroupWhiteList (final String groupId, final List< String > members, final EMCallBack callBack) |
void | checkIfInGroupWhiteList (final String groupId, EMValueCallBack< Boolean > callBack) |
void | fetchGroupWhiteList (final String groupId, final EMValueCallBack< List< String > > callBack) |
void | muteAllMembers (final String groupId, final EMValueCallBack< EMGroup > callBack) |
void | unmuteAllMembers (final String groupId, final EMValueCallBack< EMGroup > callBack) |
void | updateGroupAnnouncement (String groupId, String announcement) throws HyphenateException |
void | asyncUpdateGroupAnnouncement (final String groupId, final String announcement, final EMCallBack callBack) |
String | fetchGroupAnnouncement (String groupId) throws HyphenateException |
void | asyncFetchGroupAnnouncement (final String groupId, final EMValueCallBack< String > callBack) |
EMMucSharedFile | uploadGroupSharedFile (String groupId, String filePath, EMCallBack callBack) throws HyphenateException |
void | asyncUploadGroupSharedFile (final String groupId, final String filePath, final EMCallBack callBack) |
List< EMMucSharedFile > | fetchGroupSharedFileList (String groupId, int pageNum, int pageSize) throws HyphenateException |
void | asyncFetchGroupSharedFileList (final String groupId, final int pageNum, final int pageSize, final EMValueCallBack< List< EMMucSharedFile > > callBack) |
void | deleteGroupSharedFile (String groupId, String fileId) throws HyphenateException |
void | asyncDeleteGroupSharedFile (final String groupId, final String fileId, final EMCallBack callBack) |
void | downloadGroupSharedFile (String groupId, String fileId, String savePath, EMCallBack callBack) throws HyphenateException |
void | asyncDownloadGroupSharedFile (final String groupId, final String fileId, final String savePath, final EMCallBack callBack) |
EMGroup | updateGroupExtension (String groupId, String extension) throws HyphenateException |
群组管理, 用于管理群组的创建,删除,成员管理等操作。
void com.hyphenate.chat.EMGroupManager.acceptApplication | ( | String | username, |
String | groupId | ||
) | throws HyphenateException |
批准入群申请。 仅群主和管理员可调用此方法。 异步方法见 asyncAcceptApplication(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
username | 申请人 ID。 |
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMGroup com.hyphenate.chat.EMGroupManager.acceptInvitation | ( | String | groupId, |
String | inviter | ||
) | throws HyphenateException |
接受入群邀请。 异步方法见 asyncAcceptInvitation(String, String, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
inviter | 邀请者 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMGroup com.hyphenate.chat.EMGroupManager.addGroupAdmin | ( | final String | groupId, |
final String | admin | ||
) | throws HyphenateException |
添加群组管理员。 仅群主可调用此方法,admin 无权限。 异步方法见 asyncAddGroupAdmin(String, String, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
admin | 新增的管理员 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.addGroupChangeListener | ( | EMGroupChangeListener | listener | ) |
注册群变动事件监听。 注册后,需要配合 removeGroupChangeListener(EMGroupChangeListener) 使用。
listener | 注册的群组事件监听。 |
void com.hyphenate.chat.EMGroupManager.addToGroupWhiteList | ( | final String | groupId, |
final List< String > | members, | ||
final EMCallBack | callBack | ||
) |
添加白名单。 仅群组创建者和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
members | 要添加的成员列表。 |
callBack | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.addUsersToGroup | ( | String | groupId, |
String[] | newmembers | ||
) | throws HyphenateException |
向群组中添加新成员。 仅群组创建者和管理员可调用此方法。 异步方法见 asyncAddUsersToGroup(String, String[], EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
newmembers | 要添加的新成员数组。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.addUsersToGroup | ( | String | groupId, |
String[] | newmembers, | ||
String | welcomeMessage | ||
) | throws HyphenateException |
向群组中添加新成员。 仅群主和管理员可调用此方法。 异步方法见 asyncAddUsersToGroup(String, String[], EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
newmembers | 要添加的新成员数组。 |
welcomeMessage | 邀请信息。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.applyJoinToGroup | ( | String | groupId, |
String | reason | ||
) | throws HyphenateException |
申请加入群组。 前提:群组类型为 EMGroupStyle#EMGroupStylePublicJoinNeedApproval,即需要验证的公开群组。 异步方法见 asyncApplyJoinToGroup(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组ID。 |
reason | 申请加入的原因。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.asyncAcceptApplication | ( | final String | username, |
final String | groupId, | ||
final EMCallBack | callback | ||
) |
批准入群申请。 仅群主和管理员可调用此方法。 同步方法见 acceptApplication(String, String)。
异步方法。
username | 申请人 ID。 |
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncAcceptInvitation | ( | final String | groupId, |
final String | inviter, | ||
final EMValueCallBack< EMGroup > | callback | ||
) |
接受入群邀请。 同步方法见 acceptInvitation(String, String)。
异步方法。
groupId | 群组 ID。 |
inviter | 邀请者 ID。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncAddGroupAdmin | ( | final String | groupId, |
final String | admin, | ||
final EMValueCallBack< EMGroup > | callback | ||
) |
添加群组管理员。 仅群主可调用此方法,admin 无权限。 同步方法见 addGroupAdmin(String, String)。
异步方法。
groupId | 群组 ID。 |
admin | 新增加的管理员 ID。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncAddUsersToGroup | ( | final String | groupId, |
final String[] | newmembers, | ||
final EMCallBack | callback | ||
) |
向群组中添加新成员。 仅群主和管理员可调用此方法。 同步方法见 addUsersToGroup(String, String[])。
异步方法。
groupId | 群组的 ID。 |
newmembers | 要添加的新成员数组。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncApplyJoinToGroup | ( | final String | groupId, |
final String | reason, | ||
final EMCallBack | callback | ||
) |
申请加入群组。 前提:群组类型为 EMGroupStyle#EMGroupStylePublicJoinNeedApproval,即需要需要验证的公开群。 同步方法见 applyJoinToGroup(String, String)。
异步方法。
groupId | 群组 ID。 |
reason | 申请加入的原因。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncBlockGroupMessage | ( | final String | groupId, |
final EMCallBack | callback | ||
) |
屏蔽群消息。 被屏蔽群消息的用户仍是群成员,但无法接收群消息。 同步方法见 blockGroupMessage(String)。
异步方法。
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncBlockUser | ( | final String | groupId, |
final String | username, | ||
final EMCallBack | callback | ||
) |
将用户加入群组黑名单。 先将用户移出群,再加入黑名单。加入黑名单的用户无法加入群。 仅群主和管理员可调用此方法。 同步方法见 blockUser(String, String)。
异步方法。
groupId | 群组 ID。 |
username | 要加入黑名单的用户名。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncBlockUsers | ( | final String | groupId, |
final List< String > | members, | ||
final EMCallBack | callback | ||
) |
将用户加入群组黑名单。 先将用户移出群,再加入黑名单。加入黑名单的用户无法加入群。 仅群主和管理员可调用此方法。 同步方法见 blockUsers(String, List)。
异步方法。
groupId | 群组ID。 |
members | 要加入黑名单的用户列表。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncChangeGroupDescription | ( | final String | groupId, |
final String | changedDescription, | ||
final EMCallBack | callBack | ||
) |
修改群描述。 仅群主和管理员可调用此方法。 同步方法见 changeGroupDescription(String, String)。
异步方法。
groupId | 群组 ID。 |
changedDescription | 修改后的群描述。 |
callBack | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncChangeGroupName | ( | final String | groupId, |
final String | changedGroupName, | ||
final EMCallBack | callback | ||
) |
修改群组名称。 仅群主和管理员可调用此方法。 同步方法见 changeGroupName(String, String)。
异步方法。
groupId | 需要修改名称的群组的 ID。 |
changedGroupName | 修改后的群组名称。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncChangeOwner | ( | final String | groupId, |
final String | newOwner, | ||
final EMValueCallBack< EMGroup > | callback | ||
) |
移交群组所有权。 仅群主可调用此方法。 同步方法见 changeOwner(String, String)
异步方法。
groupId | 群组 ID。 |
newOwner | 新的群主。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncCreateGroup | ( | final String | groupName, |
final String | desc, | ||
final String[] | allMembers, | ||
final String | reason, | ||
final EMGroupOptions | option, | ||
final EMValueCallBack< EMGroup > | callback | ||
) |
创建群组。 群组创建成功后,会更新内存及数据库中的数据,多端多设备会收到相应的通知事件,然后将群组更新到内存及数据库中。 可通过设置 com.hyphenate.EMMultiDeviceListener 监听相关事件,事件回调函数为 com.hyphenate.EMMultiDeviceListener#onGroupEvent(int, String, List), 第一个参数为事件,建群事件为 com.hyphenate.EMMultiDeviceListener#GROUP_CREATE。
异步方法。
groupName | 群组的名字,非必要,不设置传 null。 |
desc | 群组描述,非必要,不设置传 null。 |
allMembers | 群成员数组。群主 ID非必要。该参数不可为 null。 |
reason | 成员入群的邀请信息,非必要,不设置传 null。 |
option | 群组设置,非必要,不可为 null。详见 EMGroupOptions。 群组的其他选项如下:
|
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object),返回创建成功的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncDeclineApplication | ( | final String | username, |
final String | groupId, | ||
final String | reason, | ||
final EMCallBack | callback | ||
) |
拒绝入群申请。 仅群组创建者和管理员可调用此方法。 同步方法见 declineApplication(String, String, String)。
异步方法。
username | 申请人 ID。 |
groupId | 群组 ID。 |
reason | 拒绝理由。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncDeclineInvitation | ( | final String | groupId, |
final String | inviter, | ||
final String | reason, | ||
final EMCallBack | callback | ||
) |
拒绝入群邀请。 同步方法见 declineInvitation(String, String, String)。
异步方法。
groupId | 群组 ID。 |
inviter | 邀请人 ID。 |
reason | 拒绝理由。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncDeleteGroupSharedFile | ( | final String | groupId, |
final String | fileId, | ||
final EMCallBack | callBack | ||
) |
删除群组指定的共享文件。 成员可以删除自己上传的文件,群组拥有者或者群组管理员可以删除所有的共享文件。 同步方法见 deleteGroupSharedFile(String, String)。
异步方法。
groupId | 群组 ID。 |
fileId | 文件 ID。 |
callBack | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncDestroyGroup | ( | final String | groupId, |
final EMCallBack | callback | ||
) |
解散群组。 仅群主可调用此方法。 同步方法见 destroyGroup(String)。
异步方法。
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncDownloadGroupSharedFile | ( | final String | groupId, |
final String | fileId, | ||
final String | savePath, | ||
final EMCallBack | callBack | ||
) |
下载群组中指定的共享文件。 同步方法见 downloadGroupSharedFile(String, String, String, EMCallBack)。
异步方法。
groupId | 群组 ID。 |
fileId | 共享文件 ID。 |
savePath | 文件保存路径。 |
callBack | 结果回调,成功时回调 EMCallBack#onSuccess(), 下载文件进度回调 EMCallBack#onProgress(int, String), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncFetchGroupAnnouncement | ( | final String | groupId, |
final EMValueCallBack< String > | callBack | ||
) |
从服务器获取群公告。 群成员可调用此方法。 同步方法见 fetchGroupAnnouncement(String)。
异步方法。
groupId | 群组 ID。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncFetchGroupBlackList | ( | final String | groupId, |
final int | pageNum, | ||
final int | pageSize, | ||
final EMValueCallBack< List< String > > | callBack | ||
) |
以分页从服务器获群组黑名单。 仅群主和管理员可调用此方法。 同步方法见 fetchGroupBlackList(String, int, int)。
异步方法。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页返回的黑名单上的用户数。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回分页获取的黑名单列表; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncFetchGroupMembers | ( | final String | groupId, |
final String | cursor, | ||
final int | pageSize, | ||
final EMValueCallBack< EMCursorResult< String > > | callback | ||
) |
以分页方式获取群组成员列表。 同步方法见 fetchGroupMembers(String, String, int)。
异步方法。
groupId | 群组 ID。 |
cursor | 从这个游标位置开始取数据,首次获取数据时传 null 即可。 |
pageSize | 每页返回的群组成员数。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回分页获取结果 EMCursorResult,包含用于下次获取数据的 cursor 以及群组成员集合的对象, 如果是最后一页,cursor 返回结果为空字符串; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncFetchGroupMuteList | ( | final String | groupId, |
final int | pageNum, | ||
final int | pageSize, | ||
final EMValueCallBack< Map< String, Long > > | callBack | ||
) |
获取群组的禁言列表。 仅群主和管理员可调用此方法。 同步方法见 fetchGroupMuteList(String, int, int)。
异步方法。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页返回的禁言成员数。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回的包含禁言成员 ID 及其禁言时长的 Map,其中每一项的 key 是禁言的成员 ID,value 是禁言时长,单位是毫秒; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncFetchGroupSharedFileList | ( | final String | groupId, |
final int | pageNum, | ||
final int | pageSize, | ||
final EMValueCallBack< List< EMMucSharedFile > > | callBack | ||
) |
从服务器获取群共享文件列表。 同步方法见 fetchGroupSharedFileList(String, int, int)。
异步方法。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页返回的共享文件数。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回共享文件列表; 失败时回调 EMValueCallBack#onError(int, String)。 |
需注意以下两点:
void com.hyphenate.chat.EMGroupManager.asyncGetBlockedUsers | ( | final String | groupId, |
final EMValueCallBack< List< String > > | callback | ||
) |
获取群组的黑名单列表, 默认最多取 200 个。 仅群主和管理员可调用此方法。 同步方法见 getBlockedUsers(String)。
异步方法。
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回群组的黑名单列表; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncGetBlockedUsers | ( | final String | groupId, |
final int | pageIndex, | ||
final int | pageSize, | ||
final EMValueCallBack< List< String > > | callback | ||
) |
以分页方式获取群组的黑名单。 仅群主和管理员可调用此方法。 同步方法见 getBlockedUsers(String, int, int)。
异步方法。
groupId | 群组 ID。 |
pageIndex | 当前页码,从 1 开始。 |
pageSize | 每页返回的群组数。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回黑名单列表; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncGetGroupFromServer | ( | final String | groupId, |
final EMValueCallBack< EMGroup > | callback | ||
) |
从服务器获取群组的详细信息。 同步方法见 getGroupFromServer(String)。
异步方法。
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncGetJoinedGroupsFromServer | ( | final EMValueCallBack< List< EMGroup > > | callback | ) |
从服务器获取当前用户的所有群组。 此操作只返回群组列表,并不获取群组的所有成员信息。如果要更新某个群组包括成员的全部信息,需要再调用 getGroupFromServer(String groupId)。 同步方法见 getJoinedGroupsFromServer()。
异步方法。
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object),返回已加入的群组列表 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncGetJoinedGroupsFromServer | ( | final int | pageIndex, |
final int | pageSize, | ||
boolean | needMemberCount, | ||
boolean | needRole, | ||
final EMValueCallBack< List< EMGroup > > | callback | ||
) |
以分页方式从服务器获取当前用户已加入的群组。 此操作只返回群组列表,不包含群组的所有成员信息。如果要更新某个群组包括成员的全部信息,需要再调用 getGroupFromServer(String groupId)。 同步方法见 getJoinedGroupsFromServer(int, int, boolean, boolean)。
异步方法。
pageIndex | 当前页码,从 0 开始。 |
pageSize | 每页返回的群组数。pageSize 最大不超过 20 |
needMemberCount | 是否需要群成员人数。 |
needRole | 是否需要用户在群里的角色。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回分页获取的群组列表 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncGetJoinedGroupsFromServer | ( | final int | pageIndex, |
final int | pageSize, | ||
final EMValueCallBack< List< EMGroup > > | callback | ||
) |
以分页方式从服务器获取当前用户已加入的群组。 此操作只返回群组列表,不包含群组的所有成员信息。如果要更新某个群组包括成员的全部信息,需要再调用 getGroupFromServer(String groupId)。 同步方法见 getJoinedGroupsFromServer(int, int)。
异步方法。
pageIndex | 当前页码,从 1 开始。 |
pageSize | 每页返回的群组数。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回分页获取的群组列表 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncGetPublicGroupsFromServer | ( | final int | pageSize, |
final String | cursor, | ||
final EMValueCallBack< EMCursorResult< EMGroupInfo > > | callback | ||
) |
以分页方式从服务器获取公开群组。 同步方法见 getPublicGroupsFromServer(int, String)。
异步方法。
pageSize | 每页返回的公开群组数。 |
cursor | 从这个游标位置开始取数据,首次获取数据时传 null 即可。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回分页获取结果 EMCursorResult,包含用于下次获取数据的 cursor 以及群组list的对象。 如果是最后一页,cursor 返回结果为空字符串; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncInviteUser | ( | final String | groupId, |
final String[] | beInvitedUsernames, | ||
final String | reason, | ||
final EMCallBack | callback | ||
) |
群成员邀请用户入群。 前提:群组类型是 EMGroupStyle#EMGroupStylePrivateMemberCanInvite,即允许群成员邀请用户。 同步方法见 inviteUser(String, String[], String)。
异步方法。
groupId | 群组 ID。 |
beInvitedUsernames | 受邀用户的数组。 |
reason | 邀请原因。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncJoinGroup | ( | final String | groupId, |
final EMCallBack | callback | ||
) |
当前登录用户加入公开群。 如果是自由加入的公开群,直接进入群组;需要验证的公开群需要等待群主同意。详见 EMGroupStyle。 同步方法见 joinGroup(String)。
异步方法。
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncLeaveGroup | ( | final String | groupId, |
final EMCallBack | callback | ||
) |
当前登录用户退出群组。
异步方法。
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncMuteGroupMembers | ( | final String | groupId, |
final List< String > | muteMembers, | ||
final long | duration, | ||
final EMValueCallBack< EMGroup > | callback | ||
) |
将一组成员禁言。 仅群主和管理员可调用此方法。 同步方法见 muteGroupMembers(String, List, long)。
异步方法。
groupId | 群组 ID。 |
muteMembers | 要禁言的用户列表。 |
duration | 禁言时间,单位是毫秒。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncRemoveGroupAdmin | ( | final String | groupId, |
final String | admin, | ||
final EMValueCallBack< EMGroup > | callback | ||
) |
删除群组管理员。 仅群主可调用此方法。 同步方法见 removeGroupAdmin(String, String)。
异步方法。
groupId | 群组 ID。 |
admin | 删除的管理员 ID。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncRemoveUserFromGroup | ( | final String | groupId, |
final String | username, | ||
final EMCallBack | callback | ||
) |
将群成员移出群组。 仅群主和管理员可调用此方法。 同步方法见 removeUserFromGroup(String, String)
异步方法。
groupId | 群组 ID。 |
username | 要删除成员的用户名。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncRemoveUsersFromGroup | ( | final String | groupId, |
final List< String > | members, | ||
final EMCallBack | callback | ||
) |
从群组中删除成员。 仅群主和管理员可调用此方法。 同步方法见 removeUsersFromGroup(String, List)。
异步方法。
groupId | 群组 ID。 |
members | 要删除成员的用户名列表。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncUnblockGroupMessage | ( | final String | groupId, |
final EMCallBack | callback | ||
) |
取消屏蔽群消息。 同步方法见 unblockGroupMessage(String)。
异步方法。
groupId | 群组 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncUnblockUser | ( | final String | groupId, |
final String | username, | ||
final EMCallBack | callback | ||
) |
将用户从群组黑名单移除。 仅群主和管理员可调用此方法。 同步方法见 unblockUser(String, String)。
异步方法。
groupId | 群组 ID。 |
username | 要从黑名单中移除的用户。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncUnblockUsers | ( | final String | groupId, |
final List< String > | members, | ||
final EMCallBack | callback | ||
) |
将用户从群组黑名单移除。 仅群主和管理员可调用此方法。 同步方法见 unblockUsers(String, List)。
异步方法。
groupId | 群组 ID。 |
members | 要从黑名单中移除的用户列表。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncUnMuteGroupMembers | ( | final String | groupId, |
final List< String > | members, | ||
final EMValueCallBack< EMGroup > | callback | ||
) |
解除禁言。 仅群主和管理员可调用此方法。 同步方法见 unMuteGroupMembers(String, List)。
异步方法。
groupId | 群组 ID。 |
members | 要解除禁言的用户列表。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncUpdateGroupAnnouncement | ( | final String | groupId, |
final String | announcement, | ||
final EMCallBack | callBack | ||
) |
更新群公告。 仅群主和管理员可调用此方法。 同步方法见updateGroupAnnouncement(String, String)。
异步方法。
groupId | 群组 ID。 |
announcement | 公告内容。 |
callBack | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.asyncUploadGroupSharedFile | ( | final String | groupId, |
final String | filePath, | ||
final EMCallBack | callBack | ||
) |
上传共享文件至群组。 同步方法见 uploadGroupSharedFile(String, String, EMCallBack)。
异步方法。
groupId | 群组 ID。 |
filePath | 文件本地路径。 |
callBack | 结果回调,成功时回调 EMCallBack#onSuccess(), 上传文件进度回调 EMCallBack#onProgress(int, String), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMGroupManager.blockGroupMessage | ( | String | groupId | ) | throws HyphenateException |
屏蔽群消息。 被屏蔽群消息的用户仍是群成员,但无法接收群消息。 异步方法见 asyncBlockGroupMessage(String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.blockUser | ( | String | groupId, |
String | username | ||
) | throws HyphenateException |
将用户加入群组黑名单。 先将用户移出群,再加入黑名单。加入黑名单的用户无法加入群。 仅群主和管理员可调用此方法。 异步方法见 asyncBlockUser(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
username | 要加入黑名单的用户名。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.blockUsers | ( | String | groupId, |
List< String > | members | ||
) | throws HyphenateException |
将用户加入群组黑名单。 先将用户移出群,再加入黑名单。加入黑名单的用户无法加入群。 仅群主和管理员可调用此方法。 异步方法见 asyncBlockUsers(String, List, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
members | 要加入黑名单的用户列表。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.changeGroupDescription | ( | String | groupId, |
String | changedDescription | ||
) | throws HyphenateException |
修改群描述。 仅群主和管理员可调用此方法。 异步方法见 asyncChangeGroupDescription(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
changedDescription | 修改后的群描述。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.changeGroupName | ( | String | groupId, |
String | changedGroupName | ||
) | throws HyphenateException |
修改群组名称。 仅群主和管理员可调用此方法。 异步方法见 asyncChangeGroupName(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 要修改名称的群组的 ID。 |
changedGroupName | 修改后的群组名称。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMGroup com.hyphenate.chat.EMGroupManager.changeOwner | ( | String | groupId, |
String | newOwner | ||
) | throws HyphenateException |
移交群组所有权。 仅群主可调用此方法。 异步方法见 asyncChangeOwner(String, String, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
newOwner | 新的群主。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息详见 EMError |
void com.hyphenate.chat.EMGroupManager.checkIfInGroupWhiteList | ( | final String | groupId, |
EMValueCallBack< Boolean > | callBack | ||
) |
检查自己是否在群组白名单中。
异步方法。
groupId | 群组 ID。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回是否在群组白名单的布尔值; 失败时回调 EMValueCallBack#onError(int, String)。 |
EMGroup com.hyphenate.chat.EMGroupManager.createGroup | ( | String | groupName, |
String | desc, | ||
String[] | allMembers, | ||
String | reason, | ||
EMGroupOptions | option | ||
) | throws HyphenateException |
创建群组。 群组创建成功后,会更新内存及数据库中的数据,多端多设备会收到相应的通知事件,将群组更新到内存及数据库中。 可通过设置 com.hyphenate.EMMultiDeviceListener监听相关事件,事件回调函数为 com.hyphenate.EMMultiDeviceListener#onGroupEvent(int, String, List), 第一个参数为事件,建群事件为 com.hyphenate.EMMultiDeviceListener#GROUP_CREATE。 异步方法见 asyncCreateGroup(String, String, String[], String, EMGroupOptions, EMValueCallBack)
同步方法,会阻塞当前线程。
groupName | 群组的名字,非必要,不设置传 null。 |
desc | 群组描述,非必要,不设置传 null。 |
allMembers | 群成员数组。群主 ID 非必要。该参数不可为 null。 |
reason | 邀请群成员加入时的邀请信息,非必要,不设置传 null。 |
option | 群的设置,非必要,不可为 null。详见 EMGroupOptions。 群组的其他选项如下:
|
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.declineApplication | ( | String | username, |
String | groupId, | ||
String | reason | ||
) | throws HyphenateException |
拒绝入群申请。 仅群组创建者和管理员可调用此方法。 异步方法见 asyncDeclineApplication(String, String, String, EMCallBack)。
同步方法,会阻塞当前线程。
username | 申请人 ID。 |
groupId | 群组 ID。 |
reason | 拒绝理由。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.declineInvitation | ( | String | groupId, |
String | inviter, | ||
String | reason | ||
) | throws HyphenateException |
拒绝入群邀请。 异步方法见 asyncDeclineInvitation(String, String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
inviter | 邀请者 ID。 |
reason | 拒绝理由。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.deleteGroupSharedFile | ( | String | groupId, |
String | fileId | ||
) | throws HyphenateException |
删除群组指定的共享文件。 成员可以删除自己上传的文件,群组拥有者或者群组管理员可以删除所有的共享文件。 异步方法见 asyncDeleteGroupSharedFile(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
fileId | 文件 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.destroyGroup | ( | final String | groupId | ) | throws HyphenateException |
解散群组。 仅群主可调用此方法。 异步方法见 asyncDestroyGroup(String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.downloadGroupSharedFile | ( | String | groupId, |
String | fileId, | ||
String | savePath, | ||
EMCallBack | callBack | ||
) | throws HyphenateException |
下载群组中指定的共享文件。 注意:callback 只做进度回调用。 异步方法见 asyncDownloadGroupSharedFile(String, String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
fileId | 文件 ID。 |
savePath | 文件保存路径。 |
callBack | 下载文件进度回调。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
String com.hyphenate.chat.EMGroupManager.fetchGroupAnnouncement | ( | String | groupId | ) | throws HyphenateException |
从服务器获取群组公告。 群成员可调用此方法。 异步方法见 asyncFetchGroupAnnouncement(String, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
List< String > com.hyphenate.chat.EMGroupManager.fetchGroupBlackList | ( | String | groupId, |
int | pageNum, | ||
int | pageSize | ||
) | throws HyphenateException |
以分页方式从服务器获群组黑名单。 仅群主和管理员可调用此方法。 异步方法见 asyncFetchGroupBlackList(String, int, int, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页返回的黑名单上的用户数。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMCursorResult< String > com.hyphenate.chat.EMGroupManager.fetchGroupMembers | ( | String | groupId, |
String | cursor, | ||
int | pageSize | ||
) | throws HyphenateException |
以分页方式获取群组成员列表。 返回的结果中,当 EMCursorResult.getCursor() 为空字符串 ("") 时,表示没有更多数据。 异步方法见 asyncFetchGroupMembers(String, String, int, EMValueCallBack)
同步方法,会阻塞当前线程。
例如:
groupId | 群组 ID。 |
cursor | 从这个游标位置开始取数据,首次获取数据时传 null 即可。 |
pageSize | 每页返回的群组成员数。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
Map< String, Long > com.hyphenate.chat.EMGroupManager.fetchGroupMuteList | ( | String | groupId, |
int | pageNum, | ||
int | pageSize | ||
) | throws HyphenateException |
获取群组的禁言列表。 仅聊天室创建者和管理员可调用此方法。 异步方法见 asyncFetchGroupMuteList(String, int, int, EMValueCallBack)
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页返回的禁言成员数。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
List< EMMucSharedFile > com.hyphenate.chat.EMGroupManager.fetchGroupSharedFileList | ( | String | groupId, |
int | pageNum, | ||
int | pageSize | ||
) | throws HyphenateException |
从服务器获取群组的共享文件列表。 异步方法见 asyncFetchGroupSharedFileList(String, int, int, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页返回的共享文件数。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.fetchGroupWhiteList | ( | final String | groupId, |
final EMValueCallBack< List< String > > | callBack | ||
) |
获取群组白名单列表。 仅聊天室创建者和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回白名单列表; 失败时回调 EMValueCallBack#onError(int, String)。 |
List< EMGroup > com.hyphenate.chat.EMGroupManager.getAllGroups | ( | ) |
获取当前(内存)用户的所有群组。 在调用此方法之前,可调用 loadAllGroups(),提前将数据从群组加载到内存; 如果未调用 loadAllGroups(),首次会从数据库中加载群组数据,之后再从内存中加载。
List< String > com.hyphenate.chat.EMGroupManager.getBlockedUsers | ( | String | groupId | ) | throws HyphenateException |
获取群组的黑名单列表, 默认最多取 200 个. 仅群主和管理员可调用此方法。 异步方法见 asyncGetBlockedUsers(String, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
List< String > com.hyphenate.chat.EMGroupManager.getBlockedUsers | ( | String | groupId, |
int | pageIndex, | ||
int | pageSize | ||
) | throws HyphenateException |
以分页方式获取群组的黑名单。 仅群主和管理员可调用此方法。 异步方法见 asyncGetBlockedUsers(String, int, int, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
pageIndex | 当前页码,从 1 开始。 |
pageSize | 每页返回的群组数。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMGroup com.hyphenate.chat.EMGroupManager.getGroup | ( | String | groupId | ) |
根据群组 ID,从内存中获得群组对象。
groupId | 群组ID。 |
EMGroup com.hyphenate.chat.EMGroupManager.getGroupFromServer | ( | String | groupId | ) | throws HyphenateException |
从服务器获取群组的详细信息。 该方法不获取成员。如需获取成员,使用 fetchGroupMembers(String, String, int)。 异步方法见 asyncGetGroupFromServer(String, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMGroup com.hyphenate.chat.EMGroupManager.getGroupFromServer | ( | String | groupId, |
boolean | fetchMembers | ||
) | throws HyphenateException |
从服务器获取群组的详细信息。 参数 fetchMembers 为 true 的时候,获取群成员。如需获取更多成员,使用 fetchGroupMembers(String, String, int)。 只有群成员才能获取群组的成员列表。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
fetchMembers | 是否获取成员列表,默认获取 200 成员的列表。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
synchronized List< EMGroup > com.hyphenate.chat.EMGroupManager.getJoinedGroupsFromServer | ( | ) | throws HyphenateException |
从服务器获取当前用户的所有群组。 此操作只返回群组列表,并不获取群组的所有成员信息,如果要更新某个群组包括成员的全部信息,需要再调用 getGroupFromServer(String groupId)。 异步方法见 asyncGetJoinedGroupsFromServer(EMValueCallBack)。
同步方法,会阻塞当前线程。
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
synchronized List< EMGroup > com.hyphenate.chat.EMGroupManager.getJoinedGroupsFromServer | ( | int | pageIndex, |
int | pageSize | ||
) | throws HyphenateException |
以分页方式从服务器获取当前用户已加入的群组。 此操作只返回群组列表,不包含群组的所有成员信息。如果要更新某个群组包括成员的全部信息,需要再调用 getGroupFromServer(String groupId)。 异步方法见 asyncGetJoinedGroupsFromServer(int, int, EMValueCallBack)。
同步方法,会阻塞当前线程。
pageIndex | 当前页码,从 1 开始。 |
pageSize | 每页返回的群组数。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
synchronized List< EMGroup > com.hyphenate.chat.EMGroupManager.getJoinedGroupsFromServer | ( | int | pageIndex, |
int | pageSize, | ||
boolean | needMemberCount, | ||
boolean | needRole | ||
) | throws HyphenateException |
以分页方式从服务器获取当前用户已加入的群组。 此操作只返回群组列表,不包含群组的所有成员信息。如果要更新某个群组包括成员的全部信息,需要再调用 getGroupFromServer(String groupId)。 异步方法见 asyncGetJoinedGroupsFromServer(int, int, boolean, boolean, EMValueCallBack)。
同步方法,会阻塞当前线程。
pageIndex | 当前页码,从 0 开始。 |
pageSize | 每页返回的群组数。pageSize 最大不超过 20 |
needMemberCount | 是否需要群成员人数。 |
needRole | 是否需要用户在群里的角色。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMCursorResult< EMGroupInfo > com.hyphenate.chat.EMGroupManager.getPublicGroupsFromServer | ( | int | pageSize, |
String | cursor | ||
) | throws HyphenateException |
以分页方式从服务器获取公开群组。 异步方法见 asyncGetPublicGroupsFromServer(int, String, EMValueCallBack)。
同步方法,会阻塞当前线程。
pageSize | 每页返回的公开群组数。 |
cursor | 从这个游标位置开始取数据,首次获取数据时传 null 即可。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 com.hyphenate.EMError。 |
void com.hyphenate.chat.EMGroupManager.inviteUser | ( | String | groupId, |
String[] | beInvitedUsernames, | ||
String | reason | ||
) | throws HyphenateException |
邀请用户加入群组。 前提:群组类型是 EMGroupStyle#EMGroupStylePrivateMemberCanInvite,即允许群成员邀请用户。 异步方法见 asyncInviteUser(String, String[], String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
beInvitedUsernames | 受邀用户的数组。 |
reason | 邀请原因。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.joinGroup | ( | String | groupId | ) | throws HyphenateException |
当前登录用户加入公开群。 如果是自由加入的公开群,直接进入群组;需要验证的公开群需要等待群主同意。详见 EMGroupStyle。 异步方法见 asyncJoinGroup(String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.leaveGroup | ( | String | groupId | ) | throws HyphenateException |
synchronized void com.hyphenate.chat.EMGroupManager.loadAllGroups | ( | ) |
从数据库中加载所有群组。
void com.hyphenate.chat.EMGroupManager.muteAllMembers | ( | final String | groupId, |
final EMValueCallBack< EMGroup > | callBack | ||
) |
设置全员禁言。 仅群主和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
EMGroup com.hyphenate.chat.EMGroupManager.muteGroupMembers | ( | String | groupId, |
List< String > | muteMembers, | ||
long | duration | ||
) | throws HyphenateException |
将一组成员禁言。 仅群主和管理员可调用此方法。 异步方法见 asyncMuteGroupMembers(String, List, long, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
muteMembers | 要禁言的用户列表。 |
duration | 禁言时间,单位是毫秒。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.removeFromGroupWhiteList | ( | final String | groupId, |
final List< String > | members, | ||
final EMCallBack | callBack | ||
) |
移除白名单。 仅群组创建者和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
members | 需要从白名单中移除的成员 ID 列表。 |
callBack | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
EMGroup com.hyphenate.chat.EMGroupManager.removeGroupAdmin | ( | String | groupId, |
String | admin | ||
) | throws HyphenateException |
删除群组管理员。 仅群主可调用此方法。 异步方法见 asyncRemoveGroupAdmin(String, String, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
admin | 删除的管理员 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.removeGroupChangeListener | ( | EMGroupChangeListener | listener | ) |
移除群组变化监听器。 该方法在注册 addGroupChangeListener(EMGroupChangeListener)后调用。
listener | 要移除的群组监听器。 |
void com.hyphenate.chat.EMGroupManager.removeUserFromGroup | ( | final String | groupId, |
final String | username | ||
) | throws HyphenateException |
将群成员移出群组。 仅群主和管理员可调用此方法。 异步方法见 asyncRemoveUserFromGroup(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组的 ID。 |
username | 要删除成员的用户名。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.removeUsersFromGroup | ( | final String | groupId, |
final List< String > | members | ||
) | throws HyphenateException |
将群成员移出群组。 仅群主和管理员可调用此方法。 异步方法见 removeUsersFromGroup(String, List)}。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
members | 要删除成员的用户名列表。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.unblockGroupMessage | ( | String | groupId | ) | throws HyphenateException |
取消屏蔽群消息。 异步方法见 asyncUnblockGroupMessage(String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.unblockUser | ( | String | groupId, |
String | username | ||
) | throws HyphenateException |
将用户从群组黑名单中移除。 仅群主和管理员可调用此方法。 异步方法见 asyncUnblockUser(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
username | 要从黑名单中移除的用户。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.unblockUsers | ( | String | groupId, |
List< String > | members | ||
) | throws HyphenateException |
将用户从群组黑名单移除。 仅群主和管理员可调用此方法。 异步方法见 asyncBlockUsers(String, List, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
members | 要从黑名单中移除的用户列表。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.unmuteAllMembers | ( | final String | groupId, |
final EMValueCallBack< EMGroup > | callBack | ||
) |
解除全员禁言。 仅群主和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 返回更新后的群组对象; 失败时回调 EMValueCallBack#onError(int, String)。 |
EMGroup com.hyphenate.chat.EMGroupManager.unMuteGroupMembers | ( | String | groupId, |
List< String > | members | ||
) | throws HyphenateException |
解除禁言。 仅群主和管理员可调用此方法。 异步方法见 asyncUnMuteGroupMembers(String, List, EMValueCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
members | 要解除禁言的用户列表。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
void com.hyphenate.chat.EMGroupManager.updateGroupAnnouncement | ( | String | groupId, |
String | announcement | ||
) | throws HyphenateException |
更新群公告。 仅群主和管理员可调用此方法。 异步方法见 asyncUpdateGroupAnnouncement(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
announcement | 公告内容。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMGroup com.hyphenate.chat.EMGroupManager.updateGroupExtension | ( | String | groupId, |
String | extension | ||
) | throws HyphenateException |
更新群组扩展字段。 仅群主和管理员可调用此方法。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
extension | 群组扩展字段。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |
EMMucSharedFile com.hyphenate.chat.EMGroupManager.uploadGroupSharedFile | ( | String | groupId, |
String | filePath, | ||
EMCallBack | callBack | ||
) | throws HyphenateException |
上传共享文件至群组。 注意:callback 只做进度回调用。 异步方法见 asyncUploadGroupSharedFile(String, String, EMCallBack)。
同步方法,会阻塞当前线程。
groupId | 群组 ID。 |
filePath | 文件本地路径。 |
callBack | 上传文件进度回调。 |
HyphenateException | 如果有异常会在此抛出,包括错误码和错误信息,详见 EMError。 |