Search messages
Search locally synchronized message records by keywords, message types, sender, and time ranges using the OpenIM React Native SDK.
Search locally synchronized message records across multiple criteria such as keywords, message types, senders, and timestamps:
const result = await OpenIMSDK.searchLocalMessages({
conversationID,
keywordList: ['release'],
messageTypeList: [MessageType.TextMessage],
pageIndex: 1,
count: 20,
});Parameters
Supply one or more search keywords in keywordList. For standard search input bars, pass trimmed, non-empty keyword strings.
| Parameter | Type | Required | Description |
|---|---|---|---|
conversationID | string | No | Scope search to a specific conversation ID. Pass an empty string "" to execute a global search across all conversations. |
keywordList | string[] | Yes | Array of keyword strings to search for. |
keywordListMatchType | number | No | Multiple keyword matching strategy: 0 matches any keyword (OR); 1 requires all keywords to match (AND). Defaults to 0. |
senderUserIDList | string[] | No | Array of sender user IDs to restrict search results to messages sent by these users. |
messageTypeList | MessageType[] | No | Array of message types (e.g., text, pictures); defaults to common chat message types. |
searchTimePosition | number | No | Search time window endpoint (Unix timestamp in seconds). |
searchTimePeriod | number | No | Duration in seconds to search backward from searchTimePosition. |
pageIndex | number | No | Pagination page index, starting at 1. |
count | number | No | Maximum number of matching message items per page. |
Return value
A resolved Promise returns a SearchMessageResult object:
| Field | Type | Description |
|---|---|---|
totalCount | number | Total number of messages matching the search criteria. |
searchResultItems | SearchMessageResultItem[] | Search result items categorized and grouped by conversation. |
Each SearchMessageResultItem contains conversation metadata and an array of matched messages messageList: MessageItem[]. When a user taps a matching message in the search results, use Load message context to navigate to the message and reconstruct surrounding conversation context. Reset pageIndex to 1 whenever query keywords or filter criteria change.
Was this page helpful?