hyphenate_SDK4.0 4.10.0
hyphenate java IM SDK
|
Public 成员函数 | |
void | addContact (String username, String reason) throws HyphenateException |
void | asyncAddContact (final String username, final String reason, final EMCallBack callback) |
void | deleteContact (String username) throws HyphenateException |
void | deleteContact (String username, boolean keepConversation) throws HyphenateException |
void | asyncDeleteContact (final String username, final EMCallBack callback) |
List< String > | getAllContactsFromServer () throws HyphenateException |
void | asyncGetAllContactsFromServer (final EMValueCallBack< List< String > > callback) |
void | setContactListener (EMContactListener contactListener) |
void | removeContactListener (EMContactListener contactListener) |
void | addUserToBlackList (String username, boolean both) throws HyphenateException |
void | asyncAddUserToBlackList (final String username, final boolean both, final EMCallBack callback) |
void | saveBlackList (List< String > blackList) throws HyphenateException |
void | asyncSaveBlackList (final List< String > blackList, final EMCallBack callback) |
void | removeUserFromBlackList (String username) throws HyphenateException |
void | asyncRemoveUserFromBlackList (final String username, final EMCallBack callback) |
List< String > | getBlackListUsernames () |
List< String > | getBlackListFromServer () throws HyphenateException |
void | asyncGetBlackListFromServer (final EMValueCallBack< List< String > > callback) |
void | acceptInvitation (String username) throws HyphenateException |
void | asyncAcceptInvitation (final String username, final EMCallBack callback) |
void | declineInvitation (String username) throws HyphenateException |
void | asyncDeclineInvitation (final String username, final EMCallBack callback) |
List< String > | getContactsFromLocal () throws HyphenateException |
List< String > | getSelfIdsOnOtherPlatform () throws HyphenateException |
void | asyncGetSelfIdsOnOtherPlatform (final EMValueCallBack< List< String > > callback) |
void | asyncSetContactRemark (@NonNull String username, @NonNull String remark, EMCallBack callback) |
EMContact | fetchContactFromLocal (String username) throws HyphenateException |
void | asyncFetchAllContactsFromLocal (EMValueCallBack< List< EMContact > > callback) |
void | asyncFetchAllContactsFromServer (EMValueCallBack< List< EMContact > > callback) |
void | asyncFetchAllContactsFromServer (int limit, String cursor, EMValueCallBack< EMCursorResult< EMContact > > callback) |
EMContactManager 是用来记录,查询,修改用户的联系人/好友列表的类。
void com.hyphenate.chat.EMContactManager.acceptInvitation | ( | String | username | ) | throws HyphenateException |
void com.hyphenate.chat.EMContactManager.addContact | ( | String | username, |
String | reason | ||
) | throws HyphenateException |
添加联系人。
同步方法,会阻塞当前线程。
参考: 异步方法见 asyncAddContact(String, String, EMCallBack)。
username | 要添加的联系人的用户 ID。 |
reason | 添加好友的原因。选填参数,可以设置为 null 或 "" 。 |
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
void com.hyphenate.chat.EMContactManager.addUserToBlackList | ( | String | username, |
boolean | both | ||
) | throws HyphenateException |
将指定用户加入到黑名单中。
可以给黑名单的中用户发消息,但是接收不到对方发送的消息。
异步方法见asyncAddUserToBlackList(String, boolean, EMCallBack)。
批量加入黑名单见saveBlackList(List)。
同步方法,会阻塞当前线程。
username | 要添加到黑名单的用户 ID。 |
both | 此参数已废弃。 |
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
void com.hyphenate.chat.EMContactManager.asyncAcceptInvitation | ( | final String | username, |
final EMCallBack | callback | ||
) |
接受加好友的邀请。
异步方法。
同步方法见acceptInvitation(String)。
username | 发起好友请求的用户 ID。 |
callback | 该方法完成的回调。
|
void com.hyphenate.chat.EMContactManager.asyncAddContact | ( | final String | username, |
final String | reason, | ||
final EMCallBack | callback | ||
) |
添加联系人。
异步方法。
同步方法见 addContact(String, String)。
username | 要添加的联系人的用户 ID。 |
reason | 添加好友的原因。选填参数,可以设置为 null 或 "" 。 |
callback | 返回调用结果,失败会返回失败原因。 |
void com.hyphenate.chat.EMContactManager.asyncAddUserToBlackList | ( | final String | username, |
final boolean | both, | ||
final EMCallBack | callback | ||
) |
把指定用户加入到黑名单中。
可以给黑名单的中用户发消息,但是接收不到对方发送的消息。
同步方法见 addUserToBlackList(String, boolean)。
批量加入黑名单见 asyncSaveBlackList(List, EMCallBack)。
username | 要添加到黑名单的用户 ID。 |
both | 此参数已废弃。 |
callback | 该方法完成的回调。
|
void com.hyphenate.chat.EMContactManager.asyncDeclineInvitation | ( | final String | username, |
final EMCallBack | callback | ||
) |
拒绝加好友的邀请。
异步方法。
同步方法见declineInvitation(String)
username | 发起好友申请的用户 ID。 |
callback | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
void com.hyphenate.chat.EMContactManager.asyncDeleteContact | ( | final String | username, |
final EMCallBack | callback | ||
) |
删除好友。
异步方法。
同步方法见 deleteContact(String)。
username | 要删除的用户 ID。 |
callback | Success 表示调用成功,Error 表示调用失败,会包含失败原因。 |
void com.hyphenate.chat.EMContactManager.asyncFetchAllContactsFromLocal | ( | EMValueCallBack< List< EMContact > > | callback | ) |
从本地获取所有好友。
callback | 该方法完成调用的回调,成功会包含所有好友;失败则包含失败原因。 |
void com.hyphenate.chat.EMContactManager.asyncFetchAllContactsFromServer | ( | EMValueCallBack< List< EMContact > > | callback | ) |
从服务端获取所有好友。
callback | 该方法完成调用的回调,成功会包含所有好友,失败则包含失败原因。 |
void com.hyphenate.chat.EMContactManager.asyncFetchAllContactsFromServer | ( | int | limit, |
String | cursor, | ||
EMValueCallBack< EMCursorResult< EMContact > > | callback | ||
) |
从服务端分页获取所有好友。
limit | 每页期望获取的好友数量。取值范围[1-50]; |
cursor | 从这个游标位置开始取数据,首次获取数据时传空获取最新添加的好友。 |
callback | 分页获取结果 EMCursorResult,包含用于下次获取数据的 cursor 以及好友列表的对象, 如果是最后一页,cursor 返回结果为空字符串。 |
void com.hyphenate.chat.EMContactManager.asyncGetAllContactsFromServer | ( | final EMValueCallBack< List< String > > | callback | ) |
void com.hyphenate.chat.EMContactManager.asyncGetBlackListFromServer | ( | final EMValueCallBack< List< String > > | callback | ) |
void com.hyphenate.chat.EMContactManager.asyncGetSelfIdsOnOtherPlatform | ( | final EMValueCallBack< List< String > > | callback | ) |
从服务器获取当前用户的其他登录设备的登录 ID 列表。这里 ID 是一个组合值,username + "/" + resource(设备的识别号)。
异步方法。
同步方法见 getSelfIdsOnOtherPlatform()。
callback | 该方法完成的回调,成功会包含用户在其他设备上登录的 ID;失败则包含失败原因。 |
void com.hyphenate.chat.EMContactManager.asyncRemoveUserFromBlackList | ( | final String | username, |
final EMCallBack | callback | ||
) |
将用户从黑名单中移除。
同步方法见removeUserFromBlackList(String)
username | 要移除的用户 ID。 |
callback | 该方法完成的回调。
|
void com.hyphenate.chat.EMContactManager.asyncSaveBlackList | ( | final List< String > | blackList, |
final EMCallBack | callback | ||
) |
上传黑名单列表到服务器。
同步方法见 saveBlackList(List)。
blackList | 黑名单列表。 |
callback | 该方法完成的回调。
|
void com.hyphenate.chat.EMContactManager.asyncSetContactRemark | ( | @NonNull String | username, |
@NonNull String | remark, | ||
EMCallBack | callback | ||
) |
设置好友备注。
username | 好友的用户 ID |
remark | 好友备注。 |
callback | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
void com.hyphenate.chat.EMContactManager.declineInvitation | ( | String | username | ) | throws HyphenateException |
void com.hyphenate.chat.EMContactManager.deleteContact | ( | String | username | ) | throws HyphenateException |
删除联系人及其相关的会话。
同步方法,会阻塞当前线程。
username | 要删除的联系人用户 ID。 |
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
void com.hyphenate.chat.EMContactManager.deleteContact | ( | String | username, |
boolean | keepConversation | ||
) | throws HyphenateException |
删除好友。
同步方法,会阻塞当前线程。
username | |
keepConversation | 是否保留会话和消息:
|
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
EMContact com.hyphenate.chat.EMContactManager.fetchContactFromLocal | ( | String | username | ) | throws HyphenateException |
从本地获取单个好友。
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
username | 好友的用户 ID。 |
List< String > com.hyphenate.chat.EMContactManager.getAllContactsFromServer | ( | ) | throws HyphenateException |
从服务器获取所有的好友。
同步方法,会阻塞当前线程。
异步方法见asyncGetAllContactsFromServer(EMValueCallBack)
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
List< String > com.hyphenate.chat.EMContactManager.getBlackListFromServer | ( | ) | throws HyphenateException |
从服务器获取黑名单列表。
异步方法见 asyncGetBlackListFromServer(EMValueCallBack)。
同步方法,会阻塞当前线程。
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
List< String > com.hyphenate.chat.EMContactManager.getBlackListUsernames | ( | ) |
从本地获取黑名单列表。
List< String > com.hyphenate.chat.EMContactManager.getContactsFromLocal | ( | ) | throws HyphenateException |
从数据库获取好友列表。
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
List< String > com.hyphenate.chat.EMContactManager.getSelfIdsOnOtherPlatform | ( | ) | throws HyphenateException |
从服务器获取当前用户的其他登录设备的登录 ID 列表,这里的 ID 是由 user ID + "/" + resource (设备的识别号)组成。
同步方法,会阻塞当前线程。
异步方法见 asyncGetSelfIdsOnOtherPlatform(EMValueCallBack)。
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
void com.hyphenate.chat.EMContactManager.removeContactListener | ( | EMContactListener | contactListener | ) |
移除联系人监听。
添加联系人监听调用setContactListener(EMContactListener)。
void com.hyphenate.chat.EMContactManager.removeUserFromBlackList | ( | String | username | ) | throws HyphenateException |
将用户从黑名单中移除。
异步方法见 asyncRemoveUserFromBlackList(String, EMCallBack)。
同步方法,会阻塞当前线程。
username | 要移除的用户 ID。 |
HyphenateException | 如果有方法调用的异常会在这里抛出,可以看到具体错误原因。 |
void com.hyphenate.chat.EMContactManager.saveBlackList | ( | List< String > | blackList | ) | throws HyphenateException |
void com.hyphenate.chat.EMContactManager.setContactListener | ( | EMContactListener | contactListener | ) |