• UIKit
  • SDK
  • サーバー API
Chat/
SDK/
Android/
ローカル検索/
SDK
  • Chat SDK のインストール
  • Chat SDK の初期化
  • ログインとログアウト
  • メッセージ
    • Overview
    • メッセージ送信
    • メッセージの受信
    • メッセージの検索
    • メッセージ転送
    • メッセージの変更
    • メッセージ挿入
    • メッセージ削除
    • 過去のメッセージをクリアします
    • メッセージの取り消し
    • オンラインメッセージの送信
    • メッセージの既読レシート
    • クエリーメッセージ
    • ヒント
    • ターゲットグループメッセージ
    • 通知しません
    • Key-Value の拡張
    • 反応
    • 翻訳
    • メッセージの先頭固定表示
  • セッション
    • Overview
    • セッションリスト
    • セッションの取得
    • 未読数
    • セッションの先頭固定表示
    • セッションの削除
    • 下書き
    • マーク
    • セッショングループ
  • グループ
    • Overview
    • グループ管理
    • プロファイル
    • メンバー管理
    • メンバープロファイル
    • プロパティ
    • カウンター
  • コミュニティとトピック
    • コミュニティ管理
    • 権限グループ
  • ユーザー
    • ユーザープロファイル
    • ユーザー状態
    • 友達の管理
    • 友達グループ
    • ブラックリスト
    • Follow
  • ローカル検索
    • メッセージ検索
    • 友達を検索
    • グループの検索
    • グループメンバーの検索
  • シグナリング
  • インターフェースリファレンスドキュメンテーション
    • Java
  • Guideline for Beginners
  • コンソールガイド
    • アプリケーションの作成とアップグレード
    • 基本設定
    • 機能設定
    • アカウント管理
    • グループ管理
    • コールバック設定
  • 製品紹介
    • メッセージ管理
      • シングルチャットメッセージ
      • メッセージの保存
      • オフラインプッシュ
      • グループメッセージ
      • メッセージフォーマット
    • アカウントシステム
      • ログイン認証
      • オンライン状態管理
    • グループ関連
      • グループシステム
      • グループ管理
    • ユーザープロファイルとリレーションシップチェーン
      • 資料管理
      • リレーションシップチェーン管理
  • 購入ガイド
    • 課金の概要
    • 価格
  • エラーコード
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

メッセージ検索

Feature Description

Local message search is a feature essential to improve user experience of the application. It allows users to quickly and conveniently find the expected information from massive amounts of complex data. It can also be used as an operations tool to easily and efficiently navigate to extensive content.
Note
Only local messages can be searched for, for example, received messages or historical messages obtained after the API is called.
The message search feature is supported only by Enhanced SDK v5.4.666 or later.
The local message search feature is only available on the IM Premium edition. To use it, purchase the Premium Edition.

Message Search Class

Message Search Parameter Class

The message search parameter class is V2TIMMessageSearchParam (Android / iOS and macOS / Windows). When searching for messages, the SDK will execute different search logics based on the object settings.
The V2TIMMessageSearchParam parameters are as described below:
Parameter
Definition
Description
keywordList
Keyword list
It can contain up to five keywords. When the message sender and the message type are not specified, the keyword list must be set; in other cases, it can be left empty.
keywordListMatchType
Match type of the keyword list
It can be set to OR or AND. Valid values: V2TIM_KEYWORD_LIST_MATCH_TYPE_OR (default), V2TIM_KEYWORD_LIST_MATCH_TYPE_AND.
senderUserIDList
userID who sent messages
It can contain up to five user IDs.
messageTypeList
Set of the message types to be searched for
If it is left empty, messages of all the supported types (excluding V2TIMFaceElem and V2TIMGroupTipsElem) will be searched for. For more information on the values of other types, see V2TIMElemType (Android / iOS and macOS / Windows).
conversationID
Whether to search all the conversations or the specified conversation
If it is left empty, all the conversations will be searched; otherwise, the specified conversation will be searched.
searchTimePosition
Start time for the search
It is 0 by default, indicating to search from the current time point. It is a UTC timestamp in seconds.
searchTimePeriod
A past period of time starting from the start time
It is 0 by default, indicating not to limit the time range. It is in seconds. 24x60x60 represents a past day.
pageIndex
Page number
It is used to display the search result by page. 0 indicates the first page.
pageSize
Number of result items per page
It is used to display the search result by page. Set it to 0 if you don't want paged display. If too many result items are pulled at a time, a performance problem may occur.

Message Search Result Class

The message search result class is V2TIMMessageSearchResult(Android / iOS and Mac / Windows). The parameters are as described below:
Parameter
Definition
Description
totalCount
Total number of the search result items
If the specified conversation is searched, the total number of messages that meet the search criteria will be returned.
If all the conversations are searched, the total number of the conversations to which messages that meet the search criteria belong will be returned.
messageSearchResultItems
Match type of the keyword list
If the specified conversation is searched, only the result items in the conversation will be included in the returned result list.
If all the conversations are searched, messages that meet the search criteria will be grouped by conversation ID and returned by page.
Here, messageSearchResultItems is a list that contains the V2TIMMessageSearchResultItem objects (Android / iOS and macOS / Windows). The parameters are as described below:
Parameter
Definition
Description
conversationID
Conversation ID
-
messageCount
Number of messages
Number of messages that meet the search criteria and are found in the current conversation.
messageList
List of messages that meet the search criteria
If the specified conversation is searched, messageList is the list of messages in the conversation that meet the search criteria.
If all the conversations are searched, messageList may display either of the following results:
If the number of matched messages in a conversation is greater than 1, messageList is empty, and you can display "{messageCount} relevant records" on the UI.
If the number of matched messages in a conversation is equal to 1, messageList is the matched message, and you can display it on the UI and highlight the matched keyword.

Searching for the Messages in All the Conversations

When a user enters a keyword in the search box to search for messages, you can call searchLocalMessages (Android / iOS and Mac / Windows) to search for local messages of the IM SDK.
If you want to search all the conversations, you only need to leave conversationID in V2TIMMessageSearchParam empty or unspecified.
Sample code:
Android
iOS and macOS
Windows
List<String> keywordList = new ArrayList<>();
keywordList.add("abc");
keywordList.add("123");
V2TIMMessageSearchParam searchParam = new V2TIMMessageSearchParam();
// Set the keyword for the search
searchParam.setKeywordList(keywordList);
// Search for the data on page 0
searchParam.setPageIndex(0);
// Search for ten data entries per page
searchParam.setPageSize(10);
V2TIMManager.getMessageManager().searchLocalMessages(searchParam, new V2TIMValueCallback<V2TIMMessageSearchResult>() {
@Override
public void onSuccess(V2TIMMessageSearchResult v2TIMMessageSearchResult) {
// Data found successfully
}

@Override
public void onError(int code, String desc) {
// Failed to find the data
}
});
V2TIMMessageSearchParam *param = [[V2TIMMessageSearchParam alloc] init];
// Set the keyword for the search
param.keywordList = @[@"abc", @"123"];
param.messageTypeList = nil;
param.conversationID = nil;
param.searchTimePosition = 0;
param.searchTimePeriod = 0;
// Search for the data on page 0
param.pageIndex = 0;
// Search for ten data entries per page
param.pageSize = 10;
[V2TIMManager.sharedInstance searchLocalMessages:param
succ:^(V2TIMMessageSearchResult *searchResult) {
// Data found successfully. `searchResult` returns the search result.
} fail:^(int code, NSString *desc) {
// Failed to find the data
}];
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

V2TIMMessageSearchParam searchParam;
// Set the keyword for the search
searchParam.keywordList.PushBack("abc");
searchParam.keywordList.PushBack("123");
// Search for the data on page 0
searchParam.pageIndex = 0;
// Search for ten data entries per page
searchParam.pageSize = 10;

auto callback = new ValueCallback<V2TIMMessageSearchResult>{};
callback->SetCallback(
[=](const V2TIMMessageSearchResult& messageSearchResult) {
// Data found successfully
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// Failed to find the data
delete callback;
});

V2TIMManager::GetInstance()->GetMessageManager()->SearchLocalMessages(searchParam, callback);

Searching for the Messages in a Specified Conversation

When a user enters a keyword in the search box to search for messages, you can call searchLocalMessages (Android / iOS and Mac / Windows) to search for local messages of the IM SDK.
Sample code:
Android
iOS and macOS
Windows
List<String> keywordList = new ArrayList<>();
keywordList.add("abc");
keywordList.add("123");
V2TIMMessageSearchParam searchParam = new V2TIMMessageSearchParam();
// Search for one-to-one messages with the `user1` user
searchParam.setConversationID("c2c_user1");
// Set the keyword for the search
searchParam.setKeywordList(keywordList);
// Search for the data on page 0
searchParam.setPageIndex(0);
// Search for ten data entries per page
searchParam.setPageSize(10);
V2TIMManager.getMessageManager().searchLocalMessages(searchParam, new V2TIMValueCallback<V2TIMMessageSearchResult>() {
@Override
public void onSuccess(V2TIMMessageSearchResult v2TIMMessageSearchResult) {
// Data found successfully
}

@Override
public void onError(int code, String desc) {
// Failed to find the data
}
});
V2TIMMessageSearchParam *param = [[V2TIMMessageSearchParam alloc] init];
// Set the keyword for the search
param.keywordList = @[@"abc", @"123"];
param.messageTypeList = nil;
// Search for one-to-one messages with the `user1` user
param.conversationID = @"c2c_user1";
param.searchTimePosition = 0;
param.searchTimePeriod = 0;
// Search for the data on page 0
param.pageIndex = 0;
// Search for ten data entries per page
param.pageSize = 10;
[V2TIMManager.sharedInstance searchLocalMessages:param
succ:^(V2TIMMessageSearchResult *searchResult) {
// Data found successfully. `searchResult` returns the search result.
} fail:^(int code, NSString *desc) {
// Failed to find the data
}];
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

V2TIMMessageSearchParam searchParam;
// Search for one-to-one messages with the `user1` user
searchParam.conversationID = "c2c_user1";
// Set the keyword for the search
searchParam.keywordList.PushBack("abc");
searchParam.keywordList.PushBack("123");
// Search for the data on page 0
searchParam.pageIndex = 0;
// Search for ten data entries per page
searchParam.pageSize = 10;

auto callback = new ValueCallback<V2TIMMessageSearchResult>{};
callback->SetCallback(
[=](const V2TIMMessageSearchResult& messageSearchResult) {
// Data found successfully
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// Failed to find the data
delete callback;
});

V2TIMManager::GetInstance()->GetMessageManager()->SearchLocalMessages(searchParam, callback);

Typical Scenario Examples for Search

Ordinary chat software, the display of the search interface is usually divided into the following scenarios:
Figure 1: Search chats
Figure 2: Search more chats
Figure 3: Search messages for a specified conversation









We will show you in turn how to use SDK's search APIs to implement the typical scenario in above figures.

Displaying Recent Active Conversations

As shown in Figure 1, the bottom part of the search interface is the list of the last three conversations to which the messages found belong. The implementation method is as follows:
1. Set the search parameter V2TIMMessageSearchParam.
Set conversationID to null, which indicates to search all the conversations.
Set pageIndex to 0, which indicates the first page of the conversations to which the messages found belong.
Set pageSize to 3, which indicates the number of the latest conversations to be returned. Generally, the latest three conversations will be displayed on the UI.
2. Process the search callback result V2TIMMessageSearchResult.
totalCount indicates the number of all the conversations to which the matched messages belong.
The messageSearchResultItems list contains the information of the latest three conversations (that is, the pageSize parameter). Here, messageCount of the V2TIMMessageSearchResultItem element indicates the total number of messages found in the current conversation.
If the number of messages found is greater than 1, messageList is empty, and the notification message "messageCount related chat records" is displayed on the UI.
If the number of messages found is equal to 1, messageList contains the matched message, and the message content is displayed on the UI, highlighting the search keyword, such as test in the above figures.
Sample code:
Android
iOS and macOS
Windows
List<String> keywordList = new ArrayList<>();
keywordList.add("test");
V2TIMMessageSearchParam v2TIMMessageSearchParam = new V2TIMMessageSearchParam();
// Setting `conversationID` to `null` is to search for messages in all conversations and the results will be classified by conversation
v2TIMMessageSearchParam.setConversationID(null);
v2TIMMessageSearchParam.setKeywordList(keywordList);
v2TIMMessageSearchParam.setPageSize(3);
v2TIMMessageSearchParam.setPageIndex(0);
V2TIMManager.getMessageManager().searchLocalMessages(v2TIMMessageSearchParam, new V2TIMValueCallback<V2TIMMessageSearchResult>() {
@Override
public void onSuccess(V2TIMMessageSearchResult v2TIMMessageSearchResult) {
// Total number of matched conversations to which messages belong
int totalCount = v2TIMMessageSearchResult.getTotalCount();
// Last three messages classified by conversation
List<V2TIMMessageSearchResultItem> resultItemList = v2TIMMessageSearchResult.getMessageSearchResultItems();
for (V2TIMMessageSearchResultItem resultItem : resultItemList) {
// Conversation ID
String conversationID = resultItem.getConversationID();
// Total number of messages matching the conversation
int totalMessageCount = resultItem.getMessageCount();
// List of messages. If `totalMessageCount` is greater than 1, the list is empty. If `totalMessageCount` is equal to 1, the list contains the current message.
List<V2TIMMessage> v2TIMMessageList = resultItem.getMessageList();
}
}

@Override
public void onError(int code, String desc) {}
});
V2TIMMessageSearchParam *param = [[V2TIMMessageSearchParam alloc] init];
param.keywordList = @[@"test"];
// Setting `conversationID` to `nil` is to search for messages in all conversations and the results will be classified by conversation
param.conversationID = nil;
param.pageIndex = 0;
param.pageSize = 3;
[V2TIMManager.sharedInstance searchLocalMessages:param succ:^(V2TIMMessageSearchResult *searchResult) {
// Total number of matched conversations to which messages belong
NSInteger totalCount = searchResult.totalCount;
// Last three messages classified by conversation
NSArray<V2TIMMessageSearchResultItem *> *messageSearchResultItems = searchResult.messageSearchResultItems;
for (V2TIMMessageSearchResultItem *searchItem in messageSearchResultItems) {
// Conversation ID
NSString *conversationID = searchItem.conversationID;
// Total number of messages matching the conversation
NSUInteger messageCount = searchItem.messageCount;
// Message list
NSArray<V2TIMMessage *> *messageList = searchItem.messageList ?: @[];
}
} fail:^(int code, NSString *desc) {
// fail
}];
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

V2TIMMessageSearchParam searchParam;
// If `conversationID` is left empty, messages in all conversations will be searched for, and the results will be classified by conversation.
searchParam.conversationID = {};
searchParam.keywordList.PushBack("test");
searchParam.pageIndex = 0;
searchParam.pageSize = 3;

auto callback = new ValueCallback<V2TIMMessageSearchResult>{};
callback->SetCallback(
[=](const V2TIMMessageSearchResult& messageSearchResult) {
// Total number of matched conversations to which messages belong
uint32_t totalCount = messageSearchResult.totalCount;
// Last three messages classified by conversation
V2TIMMessageSearchResultItemVector messageSearchResultItems =
messageSearchResult.messageSearchResultItems;
for (size_t i = 0; i < messageSearchResultItems.Size(); ++i) {
// Conversation ID
V2TIMString conversationID = messageSearchResultItems[i].conversationID;
// Total number of messages matching the conversation
uint32_t messageCount = messageSearchResultItems[i].messageCount;
// List of messages. If `messageCount` is greater than 1, the list is empty. If `messageCount` is equal to 1, the list contains the matched message.
V2TIMMessageVector messageList = messageSearchResultItems[i].messageList;
}
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// Failed to find the data
delete callback;
});

V2TIMManager::GetInstance()->GetMessageManager()->SearchLocalMessages(searchParam, callback);

Displaying the List of Conversations to Which the Messages Found Belong

Click More Chat History in the search result page as shown in Figure 1 to redirect to the page as shown in Figure 2, which displays the list of conversations to which the messages found belong. The search parameters and results in this scenario are similar to those in the preceding scenario.
To avoid memory ballooning, we strongly recommend that you load the conversation list by page. For example, to load and display ten conversation results per page, set V2TIMMessageSearchParam as follows:
1. For the first call: Set pageSize to 10 and pageIndex to 0. Call searchLocalMessages to get the message search result, parse and display it on the first page, and get the total number of conversations from totalCount in the result callback.
2. Page count calculation: totalPage = (totalCount % pageSize == 0) ? (totalCount / pageSize) : (totalCount / pageSize + 1)
3. For the subsequent call: You can set the pageIndex parameter (pageIndex < totalPage) to query the search result on the specified subsequent page.
Sample code:
Android
iOS and macOS
Windows
......
// Calculate the total number of pages, given that ten messages are displayed per page
int totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);
......

private void searchConversation(int index) {
if (index >= totalPage) {
return;
}
List<String> keywordList = new ArrayList<>();
keywordList.add("test");
V2TIMMessageSearchParam v2TIMMessageSearchParam = new V2TIMMessageSearchParam();
v2TIMMessageSearchParam.setConversationID(null);
v2TIMMessageSearchParam.setKeywordList(keywordList);
v2TIMMessageSearchParam.setPageSize(10);
v2TIMMessageSearchParam.setPageIndex(index);
V2TIMManager.getMessageManager().searchLocalMessages(v2TIMMessageSearchParam, new V2TIMValueCallback<V2TIMMessageSearchResult>() {
@Override
public void onSuccess(V2TIMMessageSearchResult v2TIMMessageSearchResult) {
// Total number of matched conversations to which messages belong
int totalCount = v2TIMMessageSearchResult.getTotalCount();
// Calculate the total number of pages, given that ten messages are displayed per page
int totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);
// Information of messages classified by conversation
List<V2TIMMessageSearchResultItem> resultItemList = v2TIMMessageSearchResult.getMessageSearchResultItems();
for (V2TIMMessageSearchResultItem resultItem : resultItemList) {
// Conversation ID
String conversationID = resultItem.getConversationID();
// Total number of messages matching the conversation
int totalMessageCount = resultItem.getMessageCount();
// List of messages. If `totalMessageCount` is greater than 1, the list is empty. If `totalMessageCount` is equal to 1, the list contains the current message.
List<V2TIMMessage> v2TIMMessageList = resultItem.getMessageList();
}

@Override
public void onError(int code, String desc) {}
});
}

// Load the next page
public void loadMore() {
searchConversation(++pageIndex);
}
......
// Calculate the total number of pages, given that ten messages are displayed per page
NSInteger totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);
......

- (void)searchConversation:(NSUInteger)index {
if (index >= totalPage) {
return;
}
V2TIMMessageSearchParam *param = [[V2TIMMessageSearchParam alloc] init];
param.keywordList = @[@"test"];
param.conversationID = nil;
param.pageIndex = index;
param.pageSize = 10;
[V2TIMManager.sharedInstance searchLocalMessages:param succ:^(V2TIMMessageSearchResult *searchResult) {
// Total number of matched conversations to which messages belong
NSUInteger totalCount = searchResult.totalCount;
// Calculate the total number of pages, given that ten messages are displayed per page
NSUInteger totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);
// Information of messages classified by conversation
NSArray<V2TIMMessageSearchResultItem *> *messageSearchResultItems = searchResult.messageSearchResultItems;
for (V2TIMMessageSearchResultItem *searchItem in messageSearchResultItems) {
// Conversation ID
NSString *conversationID = searchItem.conversationID;
// Total number of messages matching the conversation
NSUInteger totalMessageCount = searchItem.messageCount;
// List of messages. If `totalMessageCount` is greater than 1, the list is empty. If `totalMessageCount` is equal to 1, the list contains the current message.
NSArray<V2TIMMessage *> *messageList = searchItem.messageList ?: @[];
}
} fail:^(int code, NSString *desc) {
// fail
}];
}

// Load the next page
- (void)loadMore {
[self searchConversation:++pageIndex];
}
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

// Calculate the total number of pages, given that ten messages are displayed per page
uint32_t totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);

void SearchConversation(uint32_t index) {
if (index >= totalPage) {
return;
}

V2TIMMessageSearchParam searchParam;
searchParam.keywordList.PushBack("test");
searchParam.pageIndex = index;
searchParam.pageSize = 10;

auto callback = new ValueCallback<V2TIMMessageSearchResult>{};
callback->SetCallback(
[=](const V2TIMMessageSearchResult& messageSearchResult) {
// Total number of matched conversations to which messages belong
uint32_t totalCount = messageSearchResult.totalCount;
// Calculate the total number of pages, given that ten messages are displayed per page
uint32_t totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);
// Information of messages classified by conversation
V2TIMMessageSearchResultItemVector messageSearchResultItems =
messageSearchResult.messageSearchResultItems;
for (size_t i = 0; i < messageSearchResultItems.Size(); ++i) {
// Conversation ID
V2TIMString conversationID = messageSearchResultItems[i].conversationID;
// Total number of messages matching the conversation
uint32_t messageCount = messageSearchResultItems[i].messageCount;
// List of messages. If `messageCount` is greater than 1, the list is empty. If `messageCount` is equal to 1, the list contains the matched message.
V2TIMMessageVector messageList = messageSearchResultItems[i].messageList;
}
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// Failed to find the data
delete callback;
});

V2TIMManager::GetInstance()->GetMessageManager()->SearchLocalMessages(searchParam, callback);
}

// Load the next page
void LoadMore() { SearchConversation(++pageIndex); }

Displaying the Messages Found in a Specified Conversation

In Figure 2, the conversation list is displayed, while in Figure 3, the list of messages found in a specified conversation is displayed. To avoid memory bloat, we strongly recommend you load messages by page. For example, you can load and display ten message results per page:
1. Set the search parameter V2TIMMessageSearchParam as follows (pageIndex can be calculated in the same way as described in the previous section):
Set conversationID of the search parameter V2TIMMessageSearchParam as the ID of the conversation to be searched.
For the first call: Set pageSize to 10 and pageIndex to 0. Call searchLocalMessages to get the message search result, parse and display it on the first page, and get the total number of conversations from totalCount in the result callback.
Page count calculation: totalPage = (totalCount % pageSize == 0) ? (totalCount / pageSize) : (totalCount / pageSize + 1)
For the subsequent call: You can set the pageIndex parameter (pageIndex < totalPage) to query the search result on the specified subsequent page.
2. Process the search result V2TIMMessageSearchResult:
totalCount indicates the total number of matched messages in the conversation.
The messageSearchResultItems list contains only the result items in the conversation. Here, messageCount of the V2TIMMessageSearchResultItem element is the number of messages on the page, and messageList is the list of messages on the page.
Sample code:
Android
iOS and macOS
Windows
......
// Calculate the total number of pages, given that ten messages are displayed per page
int totalMessagePage = (totalMessageCount % 10 == 0) ? (totalMessageCount / 10) : (totalMessageCount / 10 + 1);
......

private void searchMessage(int index) {
if (index >= totalMessagePage) {
return;
}
List<String> keywordList = new ArrayList<>();
keywordList.add("test");
V2TIMMessageSearchParam v2TIMMessageSearchParam = new V2TIMMessageSearchParam();
v2TIMMessageSearchParam.setConversationID(conversationID);
v2TIMMessageSearchParam.setKeywordList(keywordList);
v2TIMMessageSearchParam.setPageSize(10);
v2TIMMessageSearchParam.setPageIndex(index);
V2TIMManager.getMessageManager().searchLocalMessages(v2TIMMessageSearchParam, new V2TIMValueCallback<V2TIMMessageSearchResult>() {
@Override
public void onSuccess(V2TIMMessageSearchResult v2TIMMessageSearchResult) {
// Total number of messages matching the conversation
int totalMessageCount = v2TIMMessageSearchResult.getTotalCount();
// Calculate the total number of pages, given that ten messages are displayed per page
int totalMessagePage = (totalMessageCount % 10 == 0) ? (totalMessageCount / 10) : (totalMessageCount / 10 + 1);
// Information of the messages on the conversation page
List<V2TIMMessageSearchResultItem> resultItemList = v2TIMMessageSearchResult.getMessageSearchResultItems();
for (V2TIMMessageSearchResultItem resultItem : resultItemList) {
// Conversation ID
String conversationID = resultItem.getConversationID();
// Number of messages on the current page
int totalMessageCount = resultItem.getMessageCount();
// List of messages on the current page
List<V2TIMMessage> v2TIMMessageList = resultItem.getMessageList();
}
}

@Override
public void onError(int code, String desc) {
}
});
}
// Load the next page
public void loadMore() {
searchMessage(++pageIndex);
}
......
// Calculate the total number of pages, given that ten messages are displayed per page
NSInteger totalMessagePage = (totalMessageCount % 10 == 0) ? (totalMessageCount / 10) : (totalMessageCount / 10 + 1);
......

- (void)searchMessage:(NSUInteger)index {
if (index >= totalMessagePage) {
return;
}
V2TIMMessageSearchParam *param = [[V2TIMMessageSearchParam alloc] init];
param.keywordList = @[@"test"];
param.conversationID = conversationID;
param.pageIndex = index;
param.pageSize = 10;
[V2TIMManager.sharedInstance searchLocalMessages:param succ:^(V2TIMMessageSearchResult *searchResult) {
// Total number of messages matching the conversation
NSUInteger totalMessageCount = searchResult.totalCount;
// Calculate the total number of pages, given that ten messages are displayed per page
NSUInteger totalMessagePage = (totalMessageCount % 10 == 0) ? (totalMessageCount / 10) : (totalMessageCount / 10 + 1);
// Information of the messages on the conversation page
NSArray<V2TIMMessageSearchResultItem *> *messageSearchResultItems = searchResult.messageSearchResultItems;
for (V2TIMMessageSearchResultItem *searchItem in messageSearchResultItems) {
// Conversation ID
NSString *conversationID = searchItem.conversationID;
// Number of messages on the current page
NSUInteger totalMessageCount = searchItem.messageCount;
// List of messages on the current page
NSArray<V2TIMMessage *> *messageList = searchItem.messageList ?: @[];
}
} fail:^(int code, NSString *desc) {
// fail
}];
}

// Load the next page
- (void)loadMore {
[self searchMessage:++pageIndex];
}
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

// Calculate the total number of pages, given that ten messages are displayed per page
uint32_t totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);

void SearchConversation(uint32_t index) {
if (index >= totalPage) {
return;
}

V2TIMMessageSearchParam searchParam;
searchParam.conversationID = conversationID;
searchParam.keywordList.PushBack("test");
searchParam.pageIndex = index;
searchParam.pageSize = 10;

auto callback = new ValueCallback<V2TIMMessageSearchResult>{};
callback->SetCallback(
[=](const V2TIMMessageSearchResult& messageSearchResult) {
// Total number of messages matching the conversation
uint32_t totalCount = messageSearchResult.totalCount;
// Calculate the total number of pages, given that ten messages are displayed per page
uint32_t totalPage = (totalCount % 10 == 0) ? (totalCount / 10) : (totalCount / 10 + 1);
// Information of the messages on the conversation page
V2TIMMessageSearchResultItemVector messageSearchResultItems =
messageSearchResult.messageSearchResultItems;
for (size_t i = 0; i < messageSearchResultItems.Size(); ++i) {
// Conversation ID
V2TIMString conversationID = messageSearchResultItems[i].conversationID;
// Number of messages on the current page
uint32_t messageCount = messageSearchResultItems[i].messageCount;
// List of messages on the current page
V2TIMMessageVector messageList = messageSearchResultItems[i].messageList;
}
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// Failed to find the data
delete callback;
});

V2TIMManager::GetInstance()->GetMessageManager()->SearchLocalMessages(searchParam, callback);
}

// Load the next page
void LoadMore() { SearchConversation(++pageIndex); }

Searching for a Custom Message

In general, if you call the createCustomMessage(data) API (Android / iOS and Mac / Windows) to create a custom message. The message cannot be searched, as the SDK will save it as a binary data stream.
To enable a user to find a custom message, you need to call the createCustomMessage(data, description, extension) API (Android / iOS and macOS / Windows) to create and send the custom message and put the text to be searched for in the description parameter.
If you configure the offline push feature and specify the description parameter, the custom message will also be pushed offline, and the content specified in the desc parameter will be displayed in the notification bar. If you don't need offline push, you can use disablePush in the V2TIMOfflinePushInfo parameter of the sendMessage API (Android / iOS and Mac / Windows).
If you don't want to display the content pushed on the notification bar as the text to be searched for, you can use desc in the V2TIMOfflinePushInfo parameter to set the push content.

Searching for a Rich Media Message

Rich media messages include file, image, audio, and video messages.
For a file message, the filename is usually displayed on the UI. If you pass in the fileName parameter when calling createFileMessage to create a file message, fileName will be used as the content to be searched for and match the search keyword. If fileName is not set, the SDK will automatically extract the filename from filePath as the content to be searched for. Both fileName and filePath will be saved in the local database and on the server, which can be searched for after being pulled on another device.
For image, audio, and video messages, there is no such name as fileName, and a thumbnail or duration is usually displayed on the UI; in this case, keywordList is invalid. To enable a user to find such messages, you can specify messageTypeList as V2TIM_ELEM_TYPE_IMAGE/V2TIM_ELEM_TYPE_SOUND/V2TIM_ELEM_TYPE_VIDEO for categorized search.