#import <EMConversation.h>
Delete all message of the conversation
- Returns
- Delete result, YES: success, No: fail
Mark all message as read
- Returns
- Result of mark all message as read, YES: success, No: fail
Update conversation extend properties to DB
- Returns
- Extend properties update result, YES: success, No: fail
Get latest message that received from others
- Returns
- Message instance
Insert a message to the tail of conversation, message's conversationId should equle to conversation's conversationId, message will be inserted to DB, and update conversation's property
- Parameters
-
- Returns
- Message insert result, YES: success, No: fail
Insert a message to the end of a conversation. ConversationId of the message should be the same as conversationId of the conversation in order to insert the message into the conversation correctly.
- Parameters
-
aMessage | Message |
pError | Error |
- (void) deleteAllMessages: |
|
(EMError **) |
pError |
|
Delete all message of a conversation
- Parameters
-
Delete a message
- Parameters
-
aMessageId | Message's ID who will be deleted |
- Returns
- Message delete result, YES: success, No: fail
Delete a message
- Parameters
-
aMessageId | MessageId of the message to be deleted |
pError | Error |
Insert a message to a conversation. ConversationId of the message should be the same as conversationId of the conversation in order to insert the message into the conversation correctly.
- Parameters
-
- Returns
- Message insert result, return YES or success, return No for failure.
Insert a message to a conversation. ConversationId of the message should be the same as conversationId of the conversation in order to insert the message into the conversation correctly.
- Parameters
-
aMessage | Message |
pError | Error |
Get last received message
- Returns
- Message instance
- (void) loadMessagesFrom: |
|
(long long) |
aStartTimestamp |
to: |
|
(long long) |
aEndTimestamp |
count: |
|
(int) |
aCount |
completion: |
|
(void(^)(NSArray *aMessages, EMError *aError)) |
aCompletionBlock |
|
|
| |
Load messages within specified time range, retruning messages are sorted by receiving timestamp
- Parameters
-
aStartTimestamp | Start time's timestamp in miliseconds |
aEndTimestamp | End time's timestamp in miliseconds |
aCount | Message search direction |
aCompletionBlock | The callback block of completion |
- (void) loadMessagesStartFromId: |
|
(NSString *) |
aMessageId |
count: |
|
(int) |
aCount |
searchDirection: |
|
(EMMessageSearchDirection) |
aDirection |
completion: |
|
(void(^)(NSArray *aMessages, EMError *aError)) |
aCompletionBlock |
|
|
| |
Load messages from a specified message, returning messages are sorted by receiving timestamp. If the aMessageId is nil, return the latest received messages.
- Parameters
-
aMessageId | Reference message's ID |
aCount | Count of messages to load |
aDirection | Message search direction |
aCompletionBlock | The callback block of completion |
- (void) loadMessagesWithKeyword: |
|
(NSString *) |
aKeyword |
timestamp: |
|
(long long) |
aTimestamp |
count: |
|
(int) |
aCount |
fromUser: |
|
(NSString *) |
aSender |
searchDirection: |
|
(EMMessageSearchDirection) |
aDirection |
completion: |
|
(void(^)(NSArray *aMessages, EMError *aError)) |
aCompletionBlock |
|
|
| |
Load messages with specified keyword, returning messages are sorted by receiving timestamp. If reference timestamp is negative, load from the latest messages; if message count is negative, count deal with 1 and load one message that meet the condition.
- Parameters
-
aKeywords | Search content, will ignore it if it's empty |
aTimestamp | Reference timestamp |
aCount | Count of messages to load |
aSender | Message sender (optional) |
aDirection | Message search direction |
aCompletionBlock | The callback block of completion |
- (void) loadMessagesWithType: |
|
(EMMessageBodyType) |
aType |
timestamp: |
|
(long long) |
aTimestamp |
count: |
|
(int) |
aCount |
fromUser: |
|
(NSString *) |
aUsername |
searchDirection: |
|
(EMMessageSearchDirection) |
aDirection |
completion: |
|
(void(^)(NSArray *aMessages, EMError *aError)) |
aCompletionBlock |
|
|
| |
Load messages with specified type, returning messages are sorted by receiving timestamp. If reference timestamp is negative, load from the latest messages; if message count is negative, count deal with 1 and load one message that meet the condition.
- Parameters
-
aType | Message type to load |
aTimestamp | Reference timestamp |
aLimit | Count of messages to load |
aUsername | Message sender (optional) |
aDirection | Message search direction |
aCompletionBlock | The callback block of completion |
Get a message with the ID
- Parameters
-
- Returns
- Message instance
Get a message with the ID
- Parameters
-
aMessageId | MessageID |
pError | Error |
- (NSArray *) loadMoreMessagesContain: |
|
(NSString *) |
aKeywords |
before: |
|
(long long) |
aTimestamp |
limit: |
|
(int) |
aLimit |
from: |
|
(NSString *) |
aSender |
direction: |
|
("Use -loadMessagesContainKeywords:timestamp:count:fromUser:searchDirection:completion:") |
__deprecated_msg |
|
|
| |
Get more messages contain specified keywords from DB, result messages are sorted by received time, if reference timestamp is negative, will fetch message from latest message, andd will fetch all messages that meet the condition if aLimit is negative
- Parameters
-
aKeywords | Search content, will ignore it if it's empty |
aTimestamp | Reference timestamp |
aLimit | Count of messages to load |
aSender | Message sender, will ignore it if it's empty |
aDirection | Message search direction |
- Returns
- Message list<EMMessage>
Load messages from DB in duration, result messages are sorted by receive time, user should limit the max count to load to avoid memory issue
- Parameters
-
aStartTimestamp | Start time's timestamp in miliseconds |
aEndTimestamp | End time's timestamp in miliseconds |
aMaxCount | Message search direction |
- Returns
- Message list<EMMessage>
Get more messages from DB, result messages are sorted by receive time, and NOT include the reference message, if reference messag's ID is nil, will fetch message from latest message
- Parameters
-
aMessageId | Reference message's ID |
aLimit | Count of messages to load |
aDirection | Message search direction |
- Returns
- Message list<EMMessage>
Get more messages with specified type from DB, result messages are sorted by received time, if reference timestamp is negative, will fetch message from latest message, andd will fetch all messages that meet the condition if aLimit is negative
- Parameters
-
aType | Message type to load |
aTimestamp | Reference timestamp |
aLimit | Count of messages to load |
aSender | Message sender, will ignore it if it's empty |
aDirection | Message search direction |
- Returns
- Message list<EMMessage>
- (void) markAllMessagesAsRead: |
|
(EMError **) |
pError |
|
Mark all message as read
- Parameters
-
Mark a message as read
- Parameters
-
aMessageId | Message's ID who will be set read status |
- Returns
- Result of mark message as read, YES: success, No: fail
Mark a message as read
- Parameters
-
aMessageId | MessageID |
pError | Error |
Update a message, can't update message's messageId, conversation's latestMessage and so on properties will update after update the message
- Parameters
-
- Returns
- Message update result, YES: success, No: fail
Update a local message, conversation's latestMessage and other properties will be updated accordingly. Please note that messageId can not be updated.
- Parameters
-
aMessage | Message |
pError | Error |
- (NSString*) conversationId |
|
readnonatomiccopy |
Unique identifier of conversation
Conversation extension property
Conversation latest message
- (EMConversationType) type |
|
readnonatomicassign |
- (int) unreadMessagesCount |
|
readnonatomicassign |
The documentation for this class was generated from the following file: