hyphenate_SDK4.0 4.2.3-lite
hyphenate java IM SDK
|
Public 成员函数 | |
void | addChatRoomChangeListener (EMChatRoomChangeListener listener) |
void | removeChatRoomListener (EMChatRoomChangeListener listener) |
void | joinChatRoom (final String roomId, final EMValueCallBack< EMChatRoom > callback) |
void | joinChatRoom (final String roomId, boolean leaveOtherRooms, String ext, final EMValueCallBack< EMChatRoom > callback) |
void | leaveChatRoom (final String roomId) |
void | leaveChatRoom (final String roomId, EMCallBack callback) |
EMPageResult< EMChatRoom > | fetchPublicChatRoomsFromServer (int pageNum, int pageSize) throws HyphenateException |
void | asyncFetchPublicChatRoomsFromServer (final int pageNum, final int pageSize, final EMValueCallBack< EMPageResult< EMChatRoom > > callback) |
EMChatRoom | fetchChatRoomFromServer (String roomId) throws HyphenateException |
EMChatRoom | fetchChatRoomFromServer (String roomId, boolean fetchMembers) throws HyphenateException |
void | asyncFetchChatRoomFromServer (final String roomId, final EMValueCallBack< EMChatRoom > callback) |
EMChatRoom | getChatRoom (String roomId) |
EMCursorResult< String > | fetchChatRoomMembers (String chatRoomId, String cursor, int pageSize) throws HyphenateException |
void | asyncFetchChatRoomMembers (final String chatRoomId, final String cursor, final int pageSize, final EMValueCallBack< EMCursorResult< String > > callBack) |
String | fetchChatRoomAnnouncement (String chatRoomId) throws HyphenateException |
void | asyncFetchChatRoomAnnouncement (final String chatRoomId, final EMValueCallBack< String > callBack) |
聊天室管理类,负责聊天室加入和退出、聊天室列表获取以及成员权限管理等。 比如,加入聊天室:
void com.hyphenate.chat.EMChatRoomManager.addChatRoomChangeListener | ( | EMChatRoomChangeListener | listener | ) |
注册聊天室事件监听对象。
利用本方法注册聊天室事件监听对象后,可调用 removeChatRoomListener(EMChatRoomChangeListener) 将其移除。
listener | 聊天室事件监听对象,详见 EMChatRoomChangeListener。 |
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomAnnouncement | ( | final String | chatRoomId, |
final EMValueCallBack< String > | callBack | ||
) |
从服务器获取聊天室公告内容。
同步方法见 fetchChatRoomAnnouncement(String)。
异步方法。
chatRoomId | 聊天室 ID。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object),返回聊天室公告; 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomFromServer | ( | final String | roomId, |
final EMValueCallBack< EMChatRoom > | callback | ||
) |
从服务器获取聊天室详情。
异步方法。
同步方法见 fetchChatRoomFromServer(String)。
roomId | 聊天室 ID。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomMembers | ( | final String | chatRoomId, |
final String | cursor, | ||
final int | pageSize, | ||
final EMValueCallBack< EMCursorResult< String > > | callBack | ||
) |
获取聊天室成员列表。
异步方法。
chatRoomId | 聊天室 ID。 |
cursor | 从该游标位置开始取数据。首次调用 cursor 传空值,从最新数据开始获取。 |
pageSize | 每页期望获取的成员数。取值范围为 [1,50]。 |
callBack | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 失败时回调 EMValueCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMChatRoomManager.asyncFetchPublicChatRoomsFromServer | ( | final int | pageNum, |
final int | pageSize, | ||
final EMValueCallBack< EMPageResult< EMChatRoom > > | callback | ||
) |
以分页的方式从服务器获取聊天室。
异步方法。
pageNum | 当前页数,从 1 开始。 |
pageSize | 每页返回的记录数。取值范围为 [1,50]。 |
callback | 结果回调,成功时回调 EMValueCallBack#onSuccess(Object), 失败时回调 EMValueCallBack#onError(int, String)。 |
String com.hyphenate.chat.EMChatRoomManager.fetchChatRoomAnnouncement | ( | String | chatRoomId | ) | throws HyphenateException |
从服务器获取聊天室公告内容。
异步方法见 asyncFetchChatRoomAnnouncement(String, EMValueCallBack)。
同步方法,会阻塞当前线程。
chatRoomId | 聊天室 ID。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
EMChatRoom com.hyphenate.chat.EMChatRoomManager.fetchChatRoomFromServer | ( | String | roomId | ) | throws HyphenateException |
从服务器获取聊天室详情。
同步方法,会阻塞当前线程。
异步方法见 asyncFetchChatRoomFromServer(String, EMValueCallBack)。
roomId | 聊天室 ID。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,错误码详见 EMError。 |
EMChatRoom com.hyphenate.chat.EMChatRoomManager.fetchChatRoomFromServer | ( | String | roomId, |
boolean | fetchMembers | ||
) | throws HyphenateException |
从服务器获取聊天室详情。
同步方法,会阻塞当前线程。
roomId | 聊天室 ID。 |
fetchMembers | 是否需要获取聊天室成员。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
EMCursorResult< String > com.hyphenate.chat.EMChatRoomManager.fetchChatRoomMembers | ( | String | chatRoomId, |
String | cursor, | ||
int | pageSize | ||
) | throws HyphenateException |
获取聊天室成员列表。
异步方法见 asyncFetchChatRoomMembers(String, String, int, EMValueCallBack)。
同步方法,会阻塞当前线程。
chatRoomId | 聊天室 ID。 |
cursor | 从该游标位置开始取数据。首次调用 cursor 传空值,从最新数据开始获取。 |
pageSize | 每页期望获取的成员数。取值范围为 [1,50]。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
EMPageResult< EMChatRoom > com.hyphenate.chat.EMChatRoomManager.fetchPublicChatRoomsFromServer | ( | int | pageNum, |
int | pageSize | ||
) | throws HyphenateException |
以分页的方式从服务器获取聊天室数据。
同步方法,会阻塞当前线程。
也可使用异步方法 asyncFetchPublicChatRoomsFromServer(int, int, EMValueCallBack)。
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页期望返回的记录数。取值范围为 [1,50]。 |
HyphenateException | 如果有异常会在这里抛出,包含错误码和错误描述,详见 EMError。 |
EMChatRoom com.hyphenate.chat.EMChatRoomManager.getChatRoom | ( | String | roomId | ) |
从内存中获取聊天室。
roomId | 聊天室 ID。 |
void com.hyphenate.chat.EMChatRoomManager.joinChatRoom | ( | final String | roomId, |
boolean | leaveOtherRooms, | ||
String | ext, | ||
final EMValueCallBack< EMChatRoom > | callback | ||
) |
加入聊天室。
异步方法。
roomId | 聊天室 ID。 |
leaveOtherRooms | 是否退出其他的聊天室。 |
ext | 扩展信息。 |
callback | 聊天室加入结果回调。加入成功,回调 EMValueCallBack#onSuccess(Object) 并返回聊天室对象。 加入失败,回调 EMValueCallBack#onError(int, String),其中第一个参数为错误参数,第二个参数为错误信息。 |
void com.hyphenate.chat.EMChatRoomManager.joinChatRoom | ( | final String | roomId, |
final EMValueCallBack< EMChatRoom > | callback | ||
) |
加入聊天室。
异步方法。
roomId | 聊天室 ID。 |
callback | 聊天室加入结果回调。加入成功,回调 EMValueCallBack#onSuccess(Object) 并返回聊天室对象。 加入失败,回调 EMValueCallBack#onError(int, String),其中第一个参数为错误参数,第二个参数为错误信息。 |
void com.hyphenate.chat.EMChatRoomManager.leaveChatRoom | ( | final String | roomId | ) |
void com.hyphenate.chat.EMChatRoomManager.leaveChatRoom | ( | final String | roomId, |
EMCallBack | callback | ||
) |
退出聊天室。
利用 joinChatRoom(String, EMValueCallBack) 加入聊天室后,离开时调用此方法。
异步方法。
roomId | 聊天室 ID。 |
callback | 结果回调,成功时回调 EMCallBack#onSuccess(), 失败时回调 EMCallBack#onError(int, String)。 |
void com.hyphenate.chat.EMChatRoomManager.removeChatRoomListener | ( | EMChatRoomChangeListener | listener | ) |
移除聊天室事件监听对象。
listener | 要移除的聊天室事件监听对象。 |