Remove from Favorites

Android
iOS
JavaScript
Flutter
ReactNative

Remove messages from Favorites. Images, files, voice messages, video messages, and other message types are supported.

API Definition

/**
 * remove messages from favorites
 * @param messageIdList list of message IDs to remove
 * @param callback result callback
 */
void removeFavorite(List<String> messageIdList, ISimpleCallback callback);

Remove messages from Favorites. Images, files, voice messages, video messages, and other message types are supported.

API Definition

/// remove messages from favorites
/// - Parameters:
///   - messageIdList: list of message IDs to remove
///   - successBlock: success callback
///   - errorBlock: failure callback
- (void)removeFavorite:(NSArray <NSString *> *)messageIdList
               success:(void (^)(void))successBlock
                 error:(void (^)(JErrorCode code))errorBlock;

Remove messages from Favorites. Images, files, voice messages, video messages, and other message types are supported.

Parameters

Name	Type	Required	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.removeFavoriteMessages(params).then(() => {
  console.log('removeFavoriteMessages successfully.')
}, (error) => {
  console.log(error);
});

Remove messages from Favorites. Images, files, voice messages, video messages, and other message types are supported.

API Definition

/// remove messages from favorites
/// - Parameters:
///   - messageIdList: list of message IDs to remove
Future<int> removeFavoriteMessages(List<String> messageIdList) async