HyphenateSDK  3.3.0
Instance Methods | List of all members
<IEMChatManager> Protocol Reference

#import <IEMChatManager.h>

Inheritance diagram for <IEMChatManager>:

Instance Methods

(void) - addDelegate:delegateQueue:
 
(void) - removeDelegate:
 
(NSArray *) - getAllConversations
 
(EMConversation *) - getConversation:type:createIfNotExist:
 
(void) - deleteConversation:isDeleteMessages:completion:
 
(void) - deleteConversations:isDeleteMessages:completion:
 
(void) - importConversations:completion:
 
(NSString *) - getMessageAttachmentPath:
 
(void) - importMessages:completion:
 
(void) - updateMessage:completion:
 
(void) - sendMessageReadAck:completion:
 
(void) - sendMessage:progress:completion:
 
(void) - resendMessage:progress:completion:
 
(void) - downloadMessageThumbnail:progress:completion:
 
(void) - downloadMessageAttachment:progress:completion:
 
(void) - addDelegate:
 
("Use -getAllConversations") - __deprecated_msg
 
(BOOL) - deleteConversation:deleteMessages:
 
(BOOL) - deleteConversations:deleteMessages:
 
(BOOL) - importConversations:
 
(BOOL) - importMessages:
 
(BOOL) - updateMessage:
 
(void) - asyncSendReadAckForMessage:
 
(void) - asyncSendMessage:progress:completion:
 
(void) - asyncResendMessage:progress:completion:
 
(void) - asyncDownloadMessageThumbnail:progress:completion:
 
(void) - asyncDownloadMessageAttachments:progress:completion:
 

Detailed Description

Operations of chat

Method Documentation

- ("Use -getAllConversations") __deprecated_msg
required

Load all conversations from DB, will update conversation list in memory after this method is called

Synchronization method will block the current thread

Returns
Conversation list<EMConversation>
- (void) addDelegate: (3_1_0) 
(3_2_2) 
("Use -")  EM_DEPRECATED_IOS[IEMChatManager addDelegate:delegateQueue:] 
required

Add delegate

Parameters
aDelegateDelegate
- (void) addDelegate: (id< EMChatManagerDelegate >)  aDelegate
delegateQueue: (dispatch_queue_t)  aQueue 
required

Add delegate

Parameters
aDelegateDelegate
aQueueThe queue of call delegate method
- (void) asyncDownloadMessageAttachments: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressCompletion
completion: ("Use -downloadMessageAttachment:progress:completion")  __deprecated_msg 
required

Download message attachment(voice, video, image or file), SDK can download voice automatically, so user should NOT download voice manually except automatic download failed

Asynchronous methods

Parameters
aMessageMessage instance
aProgressCompletionThe callback block of attachment download progress
aCompletionThe callback block of download complete
- (void) asyncDownloadMessageThumbnail: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressCompletion
completion: ("Use -downloadMessageThumbnail:progress:completion:")  __deprecated_msg 
required

Download message thumbnail attachments (thumbnails of image message or first frame of video image), SDK can download thumbail automatically, so user should NOT download thumbail manually except automatic download failed

Asynchronous methods

Parameters
aMessageMessage instance
aProgressCompletionThe callback block of attachment download progress
aCompletionThe callback block of download complete
- (void) asyncResendMessage: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressCompletion
completion: ("Use -resendMessage:progress:completion:")  __deprecated_msg 
required

Resend Message

Asynchronous methods

Parameters
aMessageMessage instance
aProgressCompletionThe callback block of attachment upload progress
aCompletionThe callback block of send complete
- (void) asyncSendMessage: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressCompletion
completion: ("Use -sendMessage:progress:completion:")  __deprecated_msg 
required

Send a message

Asynchronous methods

Parameters
aMessageMessage instance
aProgressCompletionThe block of attachment upload progress
aCompletionThe block of send complete
- (void) asyncSendReadAckForMessage: ("Use -sendMessageReadAck:completion:")  __deprecated_msg
required

Send read ack for message

Asynchronous methods

Parameters
aMessageMessage instance
- (BOOL) deleteConversation: (NSString *)  aConversationId
deleteMessages: ("Use -deleteConversation:isDeleteMessages:completion:")  __deprecated_msg 
required

Delete a conversation

Parameters
aConversationIdConversation id
aDeleteMessageWhether delete messages
Returns
Whether deleted successfully
- (void) deleteConversation: (NSString *)  aConversationId
isDeleteMessages: (BOOL)  aIsDeleteMessages
completion: (void(^)(NSString *aConversationId, EMError *aError))  aCompletionBlock 
required

Delete a conversation

Parameters
aConversationIdConversation id
isDeleteMessagesWhether delete messages
aCompletionBlockThe callback block of completion
- (BOOL) deleteConversations: (NSArray *)  aConversations
deleteMessages: ("Use -deleteConversations:isDeleteMessages:completion:")  __deprecated_msg 
required

Delete multiple conversations

Parameters
aConversationsConversation list<EMConversation>
aDeleteMessageWhether delete messages
Returns
Whether deleted successfully
- (void) deleteConversations: (NSArray *)  aConversations
isDeleteMessages: (BOOL)  aIsDeleteMessages
completion: (void(^)(EMError *aError))  aCompletionBlock 
required

Delete multiple conversations

Parameters
aConversationsConversation list<EMConversation>
aIsDeleteMessagesWhether delete messages
aCompletionBlockThe callback block of completion
- (void) downloadMessageAttachment: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressBlock
completion: (void(^)(EMMessage *message, EMError *error))  aCompletionBlock 
required

Download message attachment(voice, video, image or file), SDK downloads attachment automatically, no need to download attachment manually unless automatic download failed

Parameters
aMessageMessage instance
aProgressBlockThe callback block of attachment download progress
aCompletionThe callback block of download complete
- (void) downloadMessageThumbnail: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressBlock
completion: (void(^)(EMMessage *message, EMError *error))  aCompletionBlock 
required

Download message thumbnail (thumbnail of image message or first frame of video image), SDK downloads thumbails automatically, no need to download thumbail manually unless automatic download failed.

Parameters
aMessageMessage instance
aProgressBlockThe callback block of attachment download progress
aCompletionThe callback block of download complete
- (NSArray *) getAllConversations
required

Get all conversations, by loading conversations from DB if not exist in memory

Returns
Conversation list<EMConversation>
- (EMConversation *) getConversation: (NSString *)  aConversationId
type: (EMConversationType)  aType
createIfNotExist: (BOOL)  aIfCreate 
required

Get a conversation

Parameters
aConversationIdConversation id
aTypeConversation type
aIfCreateWhether create conversation if not exist
Returns
Conversation
- (NSString *) getMessageAttachmentPath: (NSString *)  aConversationId
required

Get message attachment local path for the conversation. Delete the conversation will also delete the files under the file path.

Parameters
aConversationIdConversation id
Returns
Attachment path
- (BOOL) importConversations: ("Use -importConversations:completion:")  __deprecated_msg
required

Import multiple conversations to DB

Parameters
aConversationsConversation list<EMConversation>
Returns
Whether imported successfully
- (void) importConversations: (NSArray *)  aConversations
completion: (void(^)(EMError *aError))  aCompletionBlock 
required

Import multiple conversations to DB

Parameters
aConversationsConversation list<EMConversation>
aCompletionBlockThe callback block of completion
- (BOOL) importMessages: ("Use -importMessages:completion:")  __deprecated_msg
required

Import multiple messages

Parameters
aMessagesMessage list<EMMessage>
Returns
Whether imported successfully
- (void) importMessages: (NSArray *)  aMessages
completion: (void(^)(EMError *aError))  aCompletionBlock 
required

Import multiple messages

Parameters
aMessagesMessage list<EMMessage>
aCompletionBlockThe callback block of completion
- (void) removeDelegate: (id< EMChatManagerDelegate >)  aDelegate
required

Remove delegate

Parameters
aDelegateDelegate
- (void) resendMessage: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressBlock
completion: (void(^)(EMMessage *message, EMError *error))  aCompletionBlock 
required

Resend Message

Parameters
aMessageMessage instance
aProgressBlockThe callback block of attachment upload progress
aCompletionThe callback block of send complete
- (void) sendMessage: (EMMessage *)  aMessage
progress: (void(^)(int progress))  aProgressBlock
completion: (void(^)(EMMessage *message, EMError *error))  aCompletionBlock 
required

Send a message

Parameters
aMessageMessage instance
aProgressBlockThe block of attachment upload progress
aCompletionThe block of send complete
- (void) sendMessageReadAck: (EMMessage *)  aMessage
completion: (void(^)(EMMessage *aMessage, EMError *aError))  aCompletionBlock 
required

Send read acknowledgement for message

Parameters
aMessageMessage instance
aCompletionBlockThe callback block of completion
- (BOOL) updateMessage: ("Use -updateMessage:completion:")  __deprecated_msg
required

Update message to DB

Parameters
aMessageMessage
Returns
Whether updated successfully
- (void) updateMessage: (EMMessage *)  aMessage
completion: (void(^)(EMMessage *aMessage, EMError *aError))  aCompletionBlock 
required

Update message

Parameters
aMessageMessage
aSuccessBlockThe callback block of completion

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