hyphenate_SDK4.0 4.8.0
hyphenate java IM SDK
Public Member Functions | List of all members
com.hyphenate.chat.EMContactManager Class Reference

Public Member Functions

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)
 

Detailed Description

The EMContactManager is used to record, query, and modify contacts.

Member Function Documentation

◆ acceptInvitation()

void com.hyphenate.chat.EMContactManager.acceptInvitation ( String  username) throws HyphenateException

Accepts a friend invitation。

This is a synchronous method and blocks the current thread.

For the asynchronous method, see asyncAcceptInvitation(String, EMCallBack).

Parameters
usernameThe user who initiates the friend request.

◆ addContact()

void com.hyphenate.chat.EMContactManager.addContact ( String  username,
String  reason 
) throws HyphenateException

Adds a new contact.

This is a synchronous method and blocks the current thread.

Reference: For the asynchronous method, see asyncAddContact(String, String, EMCallBack).

Parameters
usernameThe user ID of the contact to add.
reason(optional) The invitation message. Set the parameter as null or "" if you want to ignore this parameter.
Exceptions
HyphenateExceptionA description of the issue that caused this exception.

◆ addUserToBlackList()

void com.hyphenate.chat.EMContactManager.addUserToBlackList ( String  username,
boolean  both 
) throws HyphenateException

Adds a user to the block list.

You can send messages to the users on the block list, but cannot receive message from them.

For the asynchronous method, see asyncAddUserToBlackList(String, boolean, EMCallBack).

You can add multiple users in bulk by calling saveBlackList(List).

This is a synchronous method and blocks the current thread.

Parameters
usernameThe user to add to the block list.
bothThis parameter is deprecated.
Exceptions
HyphenateExceptionA description of the issue that caused the exception.

◆ asyncAcceptInvitation()

void com.hyphenate.chat.EMContactManager.asyncAcceptInvitation ( final String  username,
final EMCallBack  callback 
)

Accepts a friend invitation.

This an asynchronous method.

For the synchronous method, see acceptInvitation(String).

Parameters
usernameThe user who initiates the friend request.
callbackThe SDK returns Success if the call succeeds, but the description of the cause if the call fails.

◆ asyncAddContact()

void com.hyphenate.chat.EMContactManager.asyncAddContact ( final String  username,
final String  reason,
final EMCallBack  callback 
)

Adds a new contact.

This is an asynchronous method.

Reference: For the synchronous method, see addContact(String, String)

Parameters
usernameThe user ID of the contact to add.
reason(optional) The invitation message. Set the parameter as null or "" if you want to ignore this parameter.
callbackThe result of the method, which contains the error information if the method fails.

◆ asyncAddUserToBlackList()

void com.hyphenate.chat.EMContactManager.asyncAddUserToBlackList ( final String  username,
final boolean  both,
final EMCallBack  callback 
)

Adds a user to the block list.

You can send messages to the users on the block list, but cannot receive message from them.

For the synchronous method, see addUserToBlackList(String, boolean).

You can add multiple users in bulk by calling asyncSaveBlackList(List, EMCallBack).

Parameters
usernameThe user to add to the block list.
bothThis parameter is deprecated.
callbackThe callback completion.
  • Success: The user is successfully added to the block list.
  • Error: The user fails to be added to the block list. The reason for the failure will be returned.

◆ asyncDeclineInvitation()

void com.hyphenate.chat.EMContactManager.asyncDeclineInvitation ( final String  username,
final EMCallBack  callback 
)

Declines a friend invitation.

This an asynchronous method.

For the synchronous method, see declineInvitation(String).

Parameters
usernameThe user who initiates the friend request.
callbackThe SDK returns Success if the call succeeds, but the description of the cause if the call fails.

◆ asyncDeleteContact()

void com.hyphenate.chat.EMContactManager.asyncDeleteContact ( final String  username,
final EMCallBack  callback 
)

Deletes a contact.

This is an asynchronous method.

For the synchronous method, see deleteContact(String).

Parameters
usernameThe user ID of the contact to delete.
callbackThe SDK returns Success if the call succeeds, but the description of the cause if the call fails.

◆ asyncFetchAllContactsFromLocal()

void com.hyphenate.chat.EMContactManager.asyncFetchAllContactsFromLocal ( EMValueCallBack< List< EMContact > >  callback)

Gets all contacts from the local database.

Parameters
callbackThe SDK returns Success plus all contacts if the call succeeds, but the description of the cause if the call fails.

◆ asyncFetchAllContactsFromServer() [1/2]

void com.hyphenate.chat.EMContactManager.asyncFetchAllContactsFromServer ( EMValueCallBack< List< EMContact > >  callback)

Gets all contacts from the server.

Parameters
callbackThe SDK returns Success plus all contacts if the call succeeds, but the description of the cause if the call fails.

◆ asyncFetchAllContactsFromServer() [2/2]

void com.hyphenate.chat.EMContactManager.asyncFetchAllContactsFromServer ( int  limit,
String  cursor,
EMValueCallBack< EMCursorResult< EMContact > >  callback 
)

Gets all contacts from the server with pagination.

Parameters
limitThe number of contacts that you expect to get on each page.The value ranges from [1-50].
cursorThe cursor position from which to start getting data. Pass null or "" at the first call of this method to get the contacts that are added most recently.
callbackEMCursorResult, including the cursor for the next query and the contact list object. For the last page, the cursor is an empty string.

◆ asyncGetAllContactsFromServer()

void com.hyphenate.chat.EMContactManager.asyncGetAllContactsFromServer ( final EMValueCallBack< List< String > >  callback)

Get all contacts from the server.

This is a synchronous method see getAllContactsFromServer().

Parameters
callbackThe SDK returns the contact list if the call succeeds, but the description of the cause if the call fails.

◆ asyncGetBlackListFromServer()

void com.hyphenate.chat.EMContactManager.asyncGetBlackListFromServer ( final EMValueCallBack< List< String > >  callback)

Gets the block list from the server.

For the synchronous method, see getBlackListFromServer().

Parameters
callbackThe SDK returns the block list if the call succeed, but the description of the cause if the call fails.

◆ asyncGetSelfIdsOnOtherPlatform()

void com.hyphenate.chat.EMContactManager.asyncGetSelfIdsOnOtherPlatform ( final EMValueCallBack< List< String > >  callback)

Gets the unique IDs of the current user on the other devices. The ID is in the format of user ID + "/" + resource (device ID).

This is an asynchronous method.

For the synchronous method, see getSelfIdsOnOtherPlatform().

Parameters
callback- The SDK returns the unique IDs of the current user on the other devices if the method succeeds.
  • The SDK returns the description of the cause of the error if the method fails.

◆ asyncRemoveUserFromBlackList()

void com.hyphenate.chat.EMContactManager.asyncRemoveUserFromBlackList ( final String  username,
final EMCallBack  callback 
)

Removes a contact from the block list.

For the synchronous method, see removeUserFromBlackList(String).

Parameters
usernameThe user to be removed from the block list.
callbackThe completion callback.
  • Success: The user is successfully removed from the block list.
  • Error: The user fails to be removed from the block list. The reason for the failure will be returned.

◆ asyncSaveBlackList()

void com.hyphenate.chat.EMContactManager.asyncSaveBlackList ( final List< String >  blackList,
final EMCallBack  callback 
)

Uploads the block list to the server.

For the synchronous method, see saveBlackList(List).

Parameters
blackListThe block list to upload to the server.
callbackThe completion callback.
  • Success: The block list is uploaded to the server.
  • Error: The block list fails to be uploaded to the server. The reason for the failure will be returned.

◆ asyncSetContactRemark()

void com.hyphenate.chat.EMContactManager.asyncSetContactRemark ( @NonNull String  username,
@NonNull String  remark,
EMCallBack  callback 
)

Sets remarks of a contact.

Parameters
usernameThe user ID of the contact.
remarkThe remarks of the contact.
callbackThe completion callback. The SDK returns Success if the call succeeds, but the description of the cause if the call fails.

◆ declineInvitation()

void com.hyphenate.chat.EMContactManager.declineInvitation ( String  username) throws HyphenateException

Declines a friend invitation.

This is a synchronous method and blocks the current thread.

For the asynchronous method, see asyncDeclineInvitation(String, EMCallBack).

Parameters
usernameThe user who initiates the invitation.

◆ deleteContact() [1/2]

void com.hyphenate.chat.EMContactManager.deleteContact ( String  username) throws HyphenateException

Deletes a contact and all the related conversations.

This is a synchronous method and blocks the current thread.

Parameters
usernameThe user ID of the contact delete.
Exceptions
HyphenateExceptionA description of the issue that caused the exception.

◆ deleteContact() [2/2]

void com.hyphenate.chat.EMContactManager.deleteContact ( String  username,
boolean  keepConversation 
) throws HyphenateException

Deletes a contact.

This is a synchronous method and blocks the current thread.

Parameters
usernameThe user ID.
keepConversationWhether to keep the related conversation and messages.
  • true: The contact is deleted, while the related conversation and messages are retained.
  • false: The related conversation and messages are deleted with the contact.
Exceptions
HyphenateExceptionA description of the issue that caused the exception.

◆ fetchContactFromLocal()

EMContact com.hyphenate.chat.EMContactManager.fetchContactFromLocal ( String  username) throws HyphenateException

Gets a contact from the local database.

Parameters
usernameThe user ID of the contact.
Exceptions
HyphenateExceptionA description of the issue that caused this call to fail.

◆ getAllContactsFromServer()

List< String > com.hyphenate.chat.EMContactManager.getAllContactsFromServer ( ) throws HyphenateException

Get all contacts from the server.

This is a synchronous method and blocks the current thread.

For the asynchronous method, see asyncGetAllContactsFromServer(EMValueCallBack).

Returns
The list of contacts.
Exceptions
HyphenateExceptionA description of the exception.

◆ getBlackListFromServer()

List< String > com.hyphenate.chat.EMContactManager.getBlackListFromServer ( ) throws HyphenateException

Gets the block list from the server.

For the asynchronous method, see asyncGetBlackListFromServer(EMValueCallBack).

This is a synchronous method and blocks the current thread.

Returns
The SDK returns the block list if the method succeeds.
Exceptions
HyphenateExceptionA description of the issue that caused the exception.

◆ getBlackListUsernames()

List< String > com.hyphenate.chat.EMContactManager.getBlackListUsernames ( )

Gets the local block list.

Returns
The block list.

◆ getContactsFromLocal()

List< String > com.hyphenate.chat.EMContactManager.getContactsFromLocal ( ) throws HyphenateException

Gets the contact list from the local database.

Returns
The contact list.
Exceptions
HyphenateExceptionA description of the issue that caused the exception.

◆ getSelfIdsOnOtherPlatform()

List< String > com.hyphenate.chat.EMContactManager.getSelfIdsOnOtherPlatform ( ) throws HyphenateException

Gets the unique IDs of the current user on the other devices. The ID is in the format of user ID + "/" + resource (device ID).

This is a synchronous method and blocks the current thread.

For the asynchronous method, see asyncGetSelfIdsOnOtherPlatform(EMValueCallBack).

Returns
The SDK returns the unique IDs of the current user on the other devices if the method succeeds.
Exceptions
HyphenateExceptionA description of the issue that caused this call to fail.

◆ removeContactListener()

void com.hyphenate.chat.EMContactManager.removeContactListener ( EMContactListener  contactListener)

Removes a contact listener.

You can add a contact listener by calling setContactListener(EMContactListener).

◆ removeUserFromBlackList()

void com.hyphenate.chat.EMContactManager.removeUserFromBlackList ( String  username) throws HyphenateException

Removes the contact from the block list.

For the asynchronous method, see asyncRemoveUserFromBlackList(String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters
usernameThe user to be removed from the block list.
Exceptions
HyphenateExceptionA description of the exception.

◆ saveBlackList()

void com.hyphenate.chat.EMContactManager.saveBlackList ( List< String >  blackList) throws HyphenateException

Uploads the block list to the server.

This is a synchronous method and blocks the current thread.

For the asynchronous method, see asyncSaveBlackList(List, EMCallBack).

Parameters
blackListThe block list to upload to the server.

◆ setContactListener()

void com.hyphenate.chat.EMContactManager.setContactListener ( EMContactListener  contactListener)

Registers a new contact listener.

You can call removeContactListener(EMContactListener) to remove the listener.

Parameters
contactListenerThe contact listener to register.

The documentation for this class was generated from the following file: