Public Member Functions
void	addContact (String username, String reason) throws ChatException

void	asyncAddContact (final String username, final String reason, final CallBack callback)

void	deleteContact (String username) throws ChatException

void	deleteContact (String username, boolean keepConversation) throws ChatException

void	asyncDeleteContact (final String username, final CallBack callback)

List< String >	getAllContactsFromServer () throws ChatException

void	asyncGetAllContactsFromServer (final ValueCallBack< List< String > > callback)

void	setContactListener (ContactListener contactListener)

void	removeContactListener (ContactListener contactListener)

void	addUserToBlackList (String username, boolean both) throws ChatException

void	asyncAddUserToBlackList (final String username, final boolean both, final CallBack callback)

void	saveBlackList (List< String > blackList) throws ChatException

void	asyncSaveBlackList (final List< String > blackList, final CallBack callback)

void	removeUserFromBlackList (String username) throws ChatException

void	asyncRemoveUserFromBlackList (final String username, final CallBack callback)

List< String >	getBlackListUsernames ()

List< String >	getBlackListFromServer () throws ChatException

void	asyncGetBlackListFromServer (final ValueCallBack< List< String > > callback)

void	acceptInvitation (String username) throws ChatException

void	asyncAcceptInvitation (final String username, final CallBack callback)

void	declineInvitation (String username) throws ChatException

void	asyncDeclineInvitation (final String username, final CallBack callback)

List< String >	getContactsFromLocal () throws ChatException

List< String >	getSelfIdsOnOtherPlatform () throws ChatException

void	asyncGetSelfIdsOnOtherPlatform (final ValueCallBack< List< String > > callback)

Detailed Description

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

Member Function Documentation

◆ acceptInvitation()

void io.agora.chat.ContactManager.acceptInvitation ( String username ) throws ChatException

Accepts a friend invitation。

This is a synchronous method and blocks the current thread.

Reference： For the asynchronous method, see asyncAcceptInvitation(String, CallBack)

Parameters

username The user who initiates the friend request.

◆ addContact()

void io.agora.chat.ContactManager.addContact	(	String	username,
		String	reason
	)		throws ChatException

Adds a new contact.

This is a synchronous method and blocks the current thread.

Reference： For the asynchronous method, see asyncAddContact(String, String, CallBack).

Parameters

username	The user to be added.
reason	(optional) The invitation message. Set the parameter as null if you want to ignore the information.

Exceptions

ChatException A description of the issue that caused this exception.

◆ addUserToBlackList()

void io.agora.chat.ContactManager.addUserToBlackList	(	String	username,
		boolean	both
	)		throws ChatException

Adds a user to blocklist. You can send message to the user in blocklist, but you can not receive the message sent by the other.

Reference： For the asynchronous method, see asyncAddUserToBlackList(String, boolean, CallBack). Adds the batch blocklist by calling saveBlackList(List).

This is a synchronous method and blocks the current thread.

Parameters

username	The user to be blocked.
both	This parameter is deprecated.

Exceptions

ChatException A description of the issue that caused the exception.

◆ asyncAcceptInvitation()

void io.agora.chat.ContactManager.asyncAcceptInvitation	(	final String	username,
		final CallBack	callback
	)

Accepts a friend invitation.

This an asynchronous method.

Reference: For the synchronous method, see acceptInvitation(String).

Parameters

username	The user who initiates the friend request.
callback	Returns `Success` if the call succeed and the description of the cause if the call fails.

◆ asyncAddContact()

void io.agora.chat.ContactManager.asyncAddContact	(	final String	username,
		final String	reason,
		final CallBack	callback
	)

Adds a new contact.

This is an asynchronous method.

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

Parameters

username	The user ID of the contact to be added.
reason	The message for adding contact (optional).
callback	The result of the method, which contains the error information if the method fails.

◆ asyncAddUserToBlackList()

void io.agora.chat.ContactManager.asyncAddUserToBlackList	(	final String	username,
		final boolean	both,
		final CallBack	callback
	)

Adds the user to blocklist. You can send message to the user in the blocklist, but you can not receive the message sent by the user in the blocklist.

Reference: For the synchronous method, see addUserToBlackList(String, boolean). If you want to add multiple users in a batch to the blocklist, see asyncSaveBlackList(List, CallBack).

Parameters

username	The user to be blocked.
both	This parameter is deprecated.
callback	The callback completion. `Success`: The user is successfully added to the blocklist. `Error`: The user fails to be added to the blocklist. In this case, an error message is returned.

◆ asyncDeclineInvitation()

void io.agora.chat.ContactManager.asyncDeclineInvitation	(	final String	username,
		final CallBack	callback
	)

Declines a friend invitation.

This an asynchronous method.

Reference: For the synchronous method, see declineInvitation(String).

Parameters

username	The user who initiates the friend request.
callback	Returns `Success` if the call succeed and the description of the cause if the call fails.

◆ asyncDeleteContact()

void io.agora.chat.ContactManager.asyncDeleteContact	(	final String	username,
		final CallBack	callback
	)

Deletes a contact.

This is an asynchronous method.

Reference: For the synchronous method, see deleteContact(String).

Parameters

username	The contact‘s user ID to be deleted.
callback	The result of the method, which contains the error information if the method fails.

◆ asyncGetAllContactsFromServer()

void io.agora.chat.ContactManager.asyncGetAllContactsFromServer ( final ValueCallBack< List< String > > callback )

Get all contacts from the server.

Reference: This is a synchronous method see getAllContactsFromServer().

Parameters

callback If the method call succeeds, returns the list of contacts; if the method call fails, returns the error information.

◆ asyncGetBlackListFromServer()

void io.agora.chat.ContactManager.asyncGetBlackListFromServer ( final ValueCallBack< List< String > > callback )

Gets the blocklist from the server.

Reference: For the synchronous method, see getBlackListFromServer().

Parameters

callback Returns the blocklist if the call succeed and the description of the cause if the call fails.

◆ asyncGetSelfIdsOnOtherPlatform()

void io.agora.chat.ContactManager.asyncGetSelfIdsOnOtherPlatform ( final ValueCallBack< List< String > > callback )

Get the unique selfID list of the current user on the other devices. The selfID contains username + "/" + resource(the device ID).

This is an asynchronous method.

Reference: For the synchronous method, see getSelfIdsOnOtherPlatform().

Parameters

callback

- Returns the unique selfID list on the other devices if the method succeeds.

Returns the description of the cause of the error if the method fails.

◆ asyncRemoveUserFromBlackList()

void io.agora.chat.ContactManager.asyncRemoveUserFromBlackList	(	final String	username,
		final CallBack	callback
	)

Removes the contact from the blocklist.

Reference: For the synchronous method, see removeUserFromBlackList(String).

Parameters

username	The user to be removed from the blocklist.
callback	The completion callback. `Success`: The user is successfully removed from the blocklist. `Error`: The user fails to be removed from the blocklist. The reason for the failure will be returned.

◆ asyncSaveBlackList()

void io.agora.chat.ContactManager.asyncSaveBlackList	(	final List< String >	blackList,
		final CallBack	callback
	)

Uploads the blocklist to server.

Reference: For the synchronous method, see saveBlackList(List).

Parameters

blackList	The blocklist.
callback	The completion callback. `Success`: The blocklist is uploaded to the server. `Error`: The blocklist fails to be uploaded to the server. The reason for the failure will be returned.

◆ declineInvitation()

void io.agora.chat.ContactManager.declineInvitation ( String username ) throws ChatException

Declines a friend invitation.

This is a synchronous method and blocks the current thread.

Reference: For the asynchronous method, see asyncDeclineInvitation(String, CallBack).

Parameters

username The user who initiates the invitation.

◆ deleteContact() [1/2]

void io.agora.chat.ContactManager.deleteContact ( String username ) throws ChatException

Deletes a contact and all the conversations associated.

This is a synchronous method and blocks the current thread.

Parameters

username The contact to be deleted.

Exceptions

ChatException A description of the issue that caused the exception.

◆ deleteContact() [2/2]

void io.agora.chat.ContactManager.deleteContact	(	String	username,
		boolean	keepConversation
	)		throws ChatException

Deletes a contact.

This is a synchronous method and blocks the current thread.

Parameters

username	The user ID.
keepConversation	Whether to keep the associated conversation and messages.

Exceptions

ChatException A description of the issue that caused the exception.

◆ getAllContactsFromServer()

List< String > io.agora.chat.ContactManager.getAllContactsFromServer ( ) throws ChatException

Get all contacts from the server.

This is a synchronous method and blocks the current thread.

Reference: For the asynchronous method, see asyncGetAllContactsFromServer(ValueCallBack).

Returns: The list of contacts.

Exceptions

ChatException A description of the exception.

◆ getBlackListFromServer()

List< String > io.agora.chat.ContactManager.getBlackListFromServer ( ) throws ChatException

Gets the blocklist from the server.

Reference: For the asynchronous method, see asyncGetBlackListFromServer(ValueCallBack).

This is a synchronous method and blocks the current thread.

Returns: Returns the blocklist if the method succeeds.

Exceptions

ChatException A description of the issue that caused the exception.

◆ getBlackListUsernames()

List< String > io.agora.chat.ContactManager.getBlackListUsernames ( )

Gets the local blocklist.

Returns: The blocklist.

◆ getContactsFromLocal()

List< String > io.agora.chat.ContactManager.getContactsFromLocal ( ) throws ChatException

Gets the contact list from the local database.

Returns: The contact list.

Exceptions

ChatException A description of the issue that caused the exception.

◆ getSelfIdsOnOtherPlatform()

List< String > io.agora.chat.ContactManager.getSelfIdsOnOtherPlatform ( ) throws ChatException

Get the unique IDs of current user on the other devices. The ID is username + "/" + resource.

This is a synchronous method and blocks the current thread.

Reference： For the asynchronous method, see asyncGetSelfIdsOnOtherPlatform(ValueCallBack).

Returns: Returns the unique device ID list on the other devices if the method succeeds.

Exceptions

ChatException A description of the issue that caused this call to fail.

◆ removeContactListener()

void io.agora.chat.ContactManager.removeContactListener ( ContactListener contactListener )

Removes the contact listener.

Reference: Adds the contact listener by calling setContactListener(ContactListener).

◆ removeUserFromBlackList()

void io.agora.chat.ContactManager.removeUserFromBlackList ( String username ) throws ChatException

Removes the contact from the blocklist.

Reference： For the asynchronous method, see asyncRemoveUserFromBlackList(String, CallBack).

This is a synchronous method and blocks the current thread.

Parameters

username The user to be removed from the blocklist.

Exceptions

ChatException A description of the exception.

◆ saveBlackList()

void io.agora.chat.ContactManager.saveBlackList ( List< String > blackList ) throws ChatException

Uploads the blocklist to server.

This is a synchronous method and blocks the current thread.

Reference: For the asynchronous method, see asyncSaveBlackList(List, CallBack).

Parameters

blackList The blocklist.

◆ setContactListener()

void io.agora.chat.ContactManager.setContactListener ( ContactListener contactListener )

Registers a new contact listener.

Reference: Call removeContactListener(ContactListener) to remove the listener.

Parameters

contactListener The contact listener to be registered.

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

io/agora/chat/ContactManager.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ acceptInvitation()

◆ addContact()

◆ addUserToBlackList()

◆ asyncAcceptInvitation()

◆ asyncAddContact()

◆ asyncAddUserToBlackList()

◆ asyncDeclineInvitation()

◆ asyncDeleteContact()

◆ asyncGetAllContactsFromServer()

◆ asyncGetBlackListFromServer()

◆ asyncGetSelfIdsOnOtherPlatform()

◆ asyncRemoveUserFromBlackList()

◆ asyncSaveBlackList()

◆ declineInvitation()

◆ deleteContact() [1/2]

◆ deleteContact() [2/2]

◆ getAllContactsFromServer()

◆ getBlackListFromServer()

◆ getBlackListUsernames()

◆ getContactsFromLocal()

◆ getSelfIdsOnOtherPlatform()

◆ removeContactListener()

◆ removeUserFromBlackList()

◆ saveBlackList()

◆ setContactListener()