Namespace electronExtension

When the sender sends a message under poor network conditions, the message reaches the server but the sender does not receive the server's ack, causing the sender to believe the message failed to send. In this case, both the server and the recipient will receive the first message. The sender then retransmits the message, which reaches the server again, resulting in two messages on the server (with the same content but different messageUids). The recipient will receive two messages with the same content but different messageUids. The SDK will deduplicate the second message with the same content. This ensures that for retransmitted messages with the same content, the sender has only one message, and the recipient also has only one message. * When the message volume is low, message deduplication has minimal impact. However, when there is a large volume of local messages, deduplication can cause performance issues. When there is a large volume of local messages and message reception is sluggish, it is recommended to disable deduplication. *

5.7.1

Example of setting the RC message deduplication switch:

const checkDuplicate = true; const res = await RongIMLib.electronExtension.setCheckDuplicateMessage(checkDuplicate); console.info('Result of setting RC message deduplication switch:', res);

This interface is exclusive to the Electron platform for paginating the local conversation list. Note: Ultra group conversations are not included.

topPriority false

5.4.0

Example of paginating the local conversation list: const startTime = 0; const count = 10; const conversationList = await RongIMLib.electronExtension.getConversationList(startTime, count); console.log('Paginated local conversation list result:', conversationList);

This API is exclusive to the Electron platform for batch retrieval of conversation lists. It returns conversation information of type IReceivedConversation by providing the unique identifier attribute of the conversation. Note:

1. Only supports one-to-one chat, group chat, and system conversations.

5.9.9

Example of batch retrieving conversation list:

const conversations = [{ conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId' }]; const conversationList = await RongIMLib.electronExtension.getConversations(conversations); console.log('Batch conversation list result:', conversationList);

This interface is exclusively available for searching local messages on the Electron platform

5.4.0

Example of searching local messages within a specified time range:

const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId' } const option = { keyword: 'keyword', startTime: 0, endTime: 1632728573423, } const res = await RongIMLib.electronExtension.searchMessageInTimeRange(conversation, option) console.info('Search local messages within a specified time range result:', res);

This interface is exclusively available on the Electron platform for retrieving messages of specified types in a conversation.

5.4.0

Example of retrieving messages of specified types in a conversation: const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId' }; const options = { messageTypes: [RongIMLib.MessageType.TEXT] }; const res = await RongIMLib.electronExtension.getHistoryMessagesByMessageTypes(conversation, option); console.info('Result of retrieving messages of specified types in a conversation:', res);

This interface is exclusive to the Electron platform and requires the business layer to enable the Cloud Storage for One-to-One and Group Messages service. The difference between this method and getRemoteHistoryMessages is that getContinuousMessages first queries the messages stored in the local database for the specified conversation. When the local messages cannot meet the query conditions, it then queries the history messages stored in the cloud for one-to-one and group messages, returning a continuous and adjacent list of message objects. Note:

1. When paginating, the timestamp used in the next request must be the one returned by the getContinuousMessages interface.
2. The logic for retrieving history messages: prioritize fetching local history messages, and if unavailable, fetch remote history messages. However, this may lead to message gaps due to offline or message compensation storage duration. Message gap phenomenon: Due to offline or message compensation storage duration, messages stored in the local database may be discontinuous or missing for a certain period. For example, if both offline and compensation messages are stored for 1 day, on the first day, A sends 1, 2, 3 to B, and on the second day, A sends 4, 5, 6 to B. When B logs in on the second day, due to the 1-day storage duration, B can only receive 4, 5, 6. Messages 1, 2, 3 are lost.
3. The Count field in the option only supports a range of 1-100.

5.9.6

Example of retrieving local and remote history messages: const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId' }; const options = { timestamp: 0, count: 20, order: 0 }; const res = await RongIMLib.electronExtension.getContinuousMessages(conversation, option); console.info('Result of retrieving local and remote history messages:', res);

Marks messages sent before the specified timestamp as read by the recipient, with the status value set to SentStatus.READ

5.4.0

Example of setting message status as read by the recipient using timestamp: const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId' }; const timestamp = Date.now(); const res = await RongIMLib.electronExtension.setMessageStatusToRead(conversation, timestamp); console.info('Result of setting message status as read by the recipient using timestamp:', res);

This interface is exclusive to the Electron platform for setting the received status of a message, supporting multiple status settings simultaneously. Sets the received status information of messages sent by the other party.

5.9.3

Example of setting the received status of a message:

const messageId = 123; const receivedStatusInfo = { isRead: true, isListened: true, }; const res = await RongIMLib.electronExtension.setMessageReceivedStatusInfo(messageId, receivedStatusInfo); console.info('Result of setting the received status of a message:', res);

This interface is exclusive to the Electron platform for setting the sending status of messages sent by the user.

5.4.0

Example of setting the sending status of a message:

const messageId = 123; const sentStatus = RongIMLib.SentStatus.SENT; const res = await RongIMLib.electronExtension.setMessageSentStatus(messageId, sentStatus); console.info('Result of setting the sending status of the message:', res);

This interface is exclusive to the Electron platform. It inserts a message into the local database without sending it to the server. Note: When inserting a message, the messageUId will not be stored in the database.

5.4.0

options = {}

Example of inserting a message:

const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId', }; const message = new RongIMLib.TextMessage({ content: 'hello' }); const options = { searchContent: 'hello', }; const res = await RongIMLib.electronExtension.insertMessage(conversation, message, options); console.info('Insert message result:', res);

This API is exclusive to the Electron platform and retrieves the total message count for a specified conversation.

5.7.2

Example of getting the total message count of a conversation:

const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId', }; const res = await RongIMLib.electronExtension.getMessageCount(conversation); console.info('Result of getting the total message count:', res);

This interface is exclusive to the Electron platform and retrieves N messages around a specified timestamp locally.

5.9.8

Example of retrieving N messages around a specified timestamp locally:

const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId', }; const option = { timestamp: 0, beforeCount: 10, afterCount: 10, }; const res = await RongIMLib.electronExtension.getMessagesAroundTimestamp(conversation, option); console.info('Result of retrieving N messages around a specified timestamp locally:', res);

This interface is only applicable to the Electron platform for retrieving all local conversation lists. Note: This interface does not include ultra group conversations.

5.4.0

Example of getting all local conversation lists: const conversationList = await RongIMLib.electronExtension.getAllConversationList(); console.log('Result of getting all local conversation lists:', conversationList);

This interface is exclusively for searching the local conversation list on the Electron platform. Note:

1. Does not include ultra group conversations.
2. Supports querying custom message types. Search fields must be set when registering custom messages; otherwise, searching will not be possible. For details, refer to the searchProps parameter in registerMessageType.

5.4.0

Example of searching the local conversation list:

const keyword = 'keyword'; const messageTypes = [RongIMLib.MessageType.TEXT]; const conversationList = await RongIMLib.electronExtension.searchConversationByContent(keyword, messageTypes); console.log('Search local conversation list result:', conversationList);

This interface is only available on the Electron platform for searching local messages Note:

1. Text-type messages only support searching content, while file-type messages only support searching name
2. Custom messages are determined by the searchProps parameter in registerMessageType
3. Reference messages are not searchable
4. If channelId is not provided, messages will be searched across all channelIds
5. If messageTypes is not provided, all searchable message types will be searched

5.4.0

Example of searching local messages by keyword: const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId', }; const keyword = 'keyword'; const startTime = Date.now(); const count = 10; const res = await RongIMLib.electronExtension.searchMessages(conversation, keyword, startTime, count); console.info('Search local messages by keyword result:', res);

This interface is exclusive to the Electron platform and searches for messages within a specified time range across all channels of a given conversation based on user ID.

5.7.10

Example of searching local messages by user ID: const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId' }; const userId = 'userId'; const startTime = Date.now(); const count = 10; const res = await RongIMLib.electronExtension.searchMessagesByUser(conversation, userId, startTime, count); console.info('Search local messages by user ID', res);

5.4.0

@since 5.9.3 MLib SDK version ≧ 5.9.3, it is recommended to use the setMessageReceivedStatusInfo interface instead

This API is exclusively available on the Electron platform. Deletes one or a group of messages from the local message database by their message IDs. When deleting multiple messages, ensure that all message IDs belong to the same conversation.

5.4.0

Example of deleting messages by message ID: const messageIds = [1, 2]; const res = await RongIMLib.electronExtension.deleteMessages(messageIds); console.info('Result of deleting messages by message ID:', res);

This interface is exclusive to the Electron platform and deletes all messages of the specified conversation from the local message database.

5.4.0

Example of clearing historical messages in a conversation:

const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId', }; const res = await RongIMLib.electronExtension.clearMessages(conversation); console.info('Result of clearing historical messages in a conversation:', res);

This API is exclusive to the Electron platform. It deletes messages older than the specified timestamp from the local message database for a single conversation.

5.4.0

Example of deleting by timestamp: const conversation = { conversationType: RongIMLib.ConversationType.PRIVATE, targetId: 'targetId', }; const timestamp = Date.now(); const cleanSpace = false; const res = await RongIMLib.electronExtension.deleteMessagesByTimestamp(conversation, timestamp, cleanSpace); console.info('Delete by timestamp result:', res);

This method is used to clear local data, including message lists, conversation lists, and the timestamp of pulled messages. Note: After clearing, logging in again will be treated as a new device for message pulling, and the operation cannot be restored. Use with caution.

5.4.0

Example of clearing local data:

const res = await RongIMLib.electronExtension.clearLocalData();
console.info('Local data clearing result:', res);

This method is used to determine whether the Electron extension is currently enabled.

5.8.3

Example of checking if Electron extension is enabled:

const res = await RongIMLib.electronExtension.enable();
console.info('Electron extension enabled status:', res);