#import <IEMContactManager.h>

类 <IEMContactManager> 继承关系图:

构造函数
(void)	- addDelegate:delegateQueue:

(void)	- removeDelegate:

(NSArray< NSString * > *_Nullable)	- getContacts

(void)	- getContactsFromServerWithCompletion:

(NSArray< NSString * > *_Nullable)	- getContactsFromServerWithError:

(EMError *_Nullable)	- addContact:message:

(void)	- addContact:message:completion:

(EMError *_Nullable)	- deleteContact:isDeleteConversation:

(void)	- deleteContact:isDeleteConversation:completion:

(void)	- approveFriendRequestFromUser:completion:

(void)	- declineFriendRequestFromUser:completion:

(NSArray< NSString * > *_Nullable)	- getBlackList

(void)	- getBlackListFromServerWithCompletion:

(NSArray< NSString * > *_Nullable)	- getBlackListFromServerWithError:

(EMError *_Nullable)	- addUserToBlackList:

(void)	- addUserToBlackList:completion:

(EMError *_Nullable)	- removeUserFromBlackList:

(void)	- removeUserFromBlackList:completion:

(EMError *_Nullable)	- acceptInvitationForUsername:

(EMError *_Nullable)	- declineInvitationForUsername:

(NSArray< NSString * > *_Nullable)	- getSelfIdsOnOtherPlatformWithError:

(void)	- getSelfIdsOnOtherPlatformWithCompletion:

详细描述

好友相关操作。

函数文档

◆ acceptInvitationForUsername:

- (EMError *_Nullable) acceptInvitationForUsername: (NSString *_Nonnull) aUsername

required

同意加好友的申请。

同步方法，会阻塞当前线程。

参数

aUsername 申请者。

返回: 错误信息。

◆ addContact:message:

- (EMError *_Nullable) addContact:	(NSString *_Nonnull)	aUsername
message:	(NSString *_Nullable)	aMessage

required

添加好友。

同步方法，会阻塞当前线程。

参数

aUsername	要添加的用户。
aMessage	邀请信息。

返回: 错误信息。

◆ addContact:message:completion:

- (void) addContact:	(NSString *_Nonnull)	aUsername
message:	(NSString *_Nullable)	aMessage
completion:	(void(^)(NSString _Nullable aUsername, EMError _Nullable aError))	aCompletionBlock

required

添加好友。

异步方法。

参数

aUsername	要添加的用户。
aMessage	邀请信息。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ addDelegate:delegateQueue:

- (void) addDelegate:	(id< EMContactManagerDelegate > _Nonnull)	aDelegate
delegateQueue:	(dispatch_queue_t)	aQueue

required

添加回调代理。

参数

aDelegate	要添加的代理。
aQueue	aQueue 是指定执行代理方法的运行队列，如果传入 nil，则运行在主队列；传入指定的运行队列则在子线程运行。

◆ addUserToBlackList:

- (EMError *_Nullable) addUserToBlackList: (NSString *_Nonnull) aUsername

required

将用户加入黑名单。

同步方法，会阻塞当前线程。

参数

aUsername 要加入黑名单的用户。

返回: 错误信息。

◆ addUserToBlackList:completion:

- (void) addUserToBlackList:	(NSString *_Nonnull)	aUsername
completion:	(void(^)(NSString _Nullable aUsername, EMError _Nullable aError))	aCompletionBlock

required

将用户加入黑名单。

异步方法。

参数

aUsername	要加入黑名单的用户。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ approveFriendRequestFromUser:completion:

- (void) approveFriendRequestFromUser:	(NSString *_Nonnull)	aUsername
completion:	(void(^)(NSString _Nullable aUsername, EMError _Nullable aError))	aCompletionBlock

required

同意好友申请。

异步方法。

参数

aUsername	申请者。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ declineFriendRequestFromUser:completion:

- (void) declineFriendRequestFromUser:	(NSString *_Nonnull)	aUsername
completion:	(void(^)(NSString aUsername, EMError _Nullable aError))	aCompletionBlock

required

拒绝好友申请。

异步方法。

参数

aUsername	申请者。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ declineInvitationForUsername:

- (EMError *_Nullable) declineInvitationForUsername: (NSString *_Nonnull) aUsername

required

拒绝加好友的申请。

同步方法，会阻塞当前线程。

参数

aUsername 申请者。

返回: 错误信息。

◆ deleteContact:isDeleteConversation:

- (EMError *_Nullable) deleteContact:	(NSString *_Nonnull)	aUsername
isDeleteConversation:	(BOOL)	aIsDeleteConversation

required

删除好友。

同步方法，会阻塞当前线程。

参数

aUsername	要删除的好友。
aIsDeleteConversation	是否删除会话。YES：删除好友，会同步删除与好友的会话，NO：仅删除好友，不删除会话。

返回: 错误信息。

◆ deleteContact:isDeleteConversation:completion:

- (void) deleteContact:	(NSString *_Nonnull)	aUsername
isDeleteConversation:	(BOOL)	aIsDeleteConversation
completion:	(void(^)(NSString _Nullable aUsername, EMError _Nullable aError))	aCompletionBlock

required

删除好友。

异步方法。

参数

aUsername	要删除的好友。
aIsDeleteConversation	是否删除会话。YES：删除好友，会同步删除与好友的会话，NO：仅删除好友，不删除会话。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getBlackList

- (NSArray< NSString * > *_Nullable) getBlackList

required

从本地获取黑名单列表。

同步方法，会阻塞当前线程。

返回: 黑名单列表。

◆ getBlackListFromServerWithCompletion:

- (void) getBlackListFromServerWithCompletion: (void(^)(NSArray< NSString * > *_Nullable aList, EMError *_Nullable aError)) aCompletionBlock

required

从服务器获取黑名单列表。

异步方法。

参数

aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getBlackListFromServerWithError:

- (NSArray< NSString * > *_Nullable) getBlackListFromServerWithError: (EMError **_Nullable) pError

required

从服务器获取黑名单列表。

同步方法，会阻塞当前线程。

参数

pError 错误信息。

返回: 黑名单列表。

◆ getContacts

- (NSArray< NSString * > *_Nullable) getContacts

required

获取本地存储的所有好友。

同步方法。

返回: 好友列表。

◆ getContactsFromServerWithCompletion:

- (void) getContactsFromServerWithCompletion: (void(^)(NSArray< NSString * > *_Nullable aList, EMError *aError_Nullable)) aCompletionBlock

required

从服务器获取所有的好友。

异步方法。

参数

aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getContactsFromServerWithError:

- (NSArray< NSString * > *_Nullable) getContactsFromServerWithError: (EMError **_Nullable) pError

required

从服务器获取所有的好友。

同步方法，会阻塞当前线程。

参数

pError 错误信息。

返回: 好友列表。

◆ getSelfIdsOnOtherPlatformWithCompletion:

- (void) getSelfIdsOnOtherPlatformWithCompletion: (void(^)(NSArray< NSString * > *_Nullable aList, EMError *_Nullable aError)) aCompletionBlock

required

获取当前账号在其他平台(Windows 或者 Web)登录的 ID 列表。 ID 使用方法类似于好友 username。

异步方法。

参数

aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getSelfIdsOnOtherPlatformWithError:

- (NSArray< NSString * > *_Nullable) getSelfIdsOnOtherPlatformWithError: (EMError **_Nullable) pError

required

获取当前账号在其他平台(Windows 或者 Web)登录的 ID 列表。 ID 使用方法类似于好友 username。

同步方法，会阻塞当前线程。

参数

pError 错误信息。

返回: ID 列表。

◆ removeDelegate:

- (void) removeDelegate: (id _Nonnull) aDelegate

required

移除回调代理。

参数

aDelegate 要移除的代理。

◆ removeUserFromBlackList:

- (EMError *_Nullable) removeUserFromBlackList: (NSString *_Nonnull) aUsername

required

将用户移出黑名单。

同步方法，会阻塞当前线程。

参数

aUsername 要移出黑名单的用户。

返回: 错误信息。

◆ removeUserFromBlackList:completion:

- (void) removeUserFromBlackList:	(NSString *_Nonnull)	aUsername
completion:	(void(^)(NSString _Nullable aUsername, EMError _Nullable aError))	aCompletionBlock

required

将用户移出黑名单。

异步方法。

参数

aUsername	要移出黑名单的用户。
aCompletionBlock	该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

该协议的文档由以下文件生成:

HyphenateChat.framework/Headers/IEMContactManager.h

构造函数

详细描述

函数文档

◆ acceptInvitationForUsername:

◆ addContact:message:

◆ addContact:message:completion:

◆ addDelegate:delegateQueue:

◆ addUserToBlackList:

◆ addUserToBlackList:completion:

◆ approveFriendRequestFromUser:completion:

◆ declineFriendRequestFromUser:completion:

◆ declineInvitationForUsername:

◆ deleteContact:isDeleteConversation:

◆ deleteContact:isDeleteConversation:completion:

◆ getBlackList

◆ getBlackListFromServerWithCompletion:

◆ getBlackListFromServerWithError:

◆ getContacts

◆ getContactsFromServerWithCompletion:

◆ getContactsFromServerWithError:

◆ getSelfIdsOnOtherPlatformWithCompletion:

◆ getSelfIdsOnOtherPlatformWithError:

◆ removeDelegate:

◆ removeUserFromBlackList:

◆ removeUserFromBlackList:completion: