- Android
- iOS
- JavaScript
- Flutter
- ReactNative
Add messages to Favorites. Images, files, voice messages, video messages, and other message types are supported.
API Definition
/**
* add messages to favorites
* @param messageIdList list of message IDs to add to favorites
* @param callback result callback
*/
void addFavorite(List<String> messageIdList, ISimpleCallback callback);
Add messages to Favorites. Images, files, voice messages, video messages, and other message types are supported.
API Definition
/// add messages to favorites
/// - Parameters:
/// - messageIdList: list of message IDs to add to favorites
/// - successBlock: success callback
/// - errorBlock: failure callback
- (void)addFavorite:(NSArray <NSString *> *)messageIdList
success:(void (^)(void))successBlock
error:(void (^)(JErrorCode code))errorBlock;
Add messages to Favorites. Images, files, voice messages, video messages, and other message types are supported.

Parameters
| Name | Type | Required | Default | Description | Version |
|---|---|---|---|---|---|
| params | Object | Yes | Message object | 1.0.0 | |
| params.messages | Array | Yes | Favorite message list | 1.0.0 | |
| params.messages[0].conversationType | Number | Yes | Conversation type | 1.0.0 | |
| params.messages[0].conversationId | String | Yes | Conversation ID. For PRIVATE conversations, it is the recipient userId; for GROUP conversations, it is the group ID. | 1.0.0 | |
| params.messages[0].senderId | String | Yes | Message sender ID. Available from Message.sender.id. | 1.0.0 | |
| params.messages[0].messageId | String | Yes | Message ID. Available from Message.messageId. | 1.0.0 |
Success Callback
No parameters are returned. The callback indicates success when invoked.
Failure Callback
| Name | Type | Description | Version |
|---|---|---|---|
| error | Object | A status code is provided when sending fails. Check error.msg directly or see status codes. | 1.0.0 |
Code Example
let { ConversationType } = JIM;
let params = {
messages: [{
conversationType: ConversationType.GROUP,
conversationId: 'groupz001',
messageId: 'nwmz3nrps6yj3rk8',
senderId: "675NdFjkx"
}]
};
jim.addFavoriteMessages(params).then(() => {
console.log('addFavoriteMessages successfully.')
}, (error) => {
console.log(error);
});
Add messages to Favorites. Images, files, voice messages, video messages, and other message types are supported.
API Definition
/// add messages to favorites
/// - Parameters:
/// - messageIdList: list of message IDs to add to favorites
Future<int> addFavoriteMessages(List<String> messageIdList) async