please select
  • UIKit
  • SDK
  • Server APIs
Chat/
UIKit/
Flutter/
Features/
UIKit
  • Overview
  • Run Demo
  • Installation
    • integrated
    • Only Chat
  • Features
    • Local Search
    • Offline Push
    • Online Status
    • Typing Status
    • Message Read Receipt
    • Message Reactions
    • Internationalization
    • Adding Custom Messages
    • Emoji & Stickers
  • Customization
    • Modifying UI Themes
    • Setting UI Styles
  • Changelog
  • Guideline for Beginners
  • Console Guide
    • Creating and Upgrading an Application
    • Basic Configuration
    • Feature Configuration
    • Account Management
    • Group Management
    • Webhook Configuration
  • Product Introduction
    • Message Management
      • One-to-One Message
      • Message Storage
      • Offline Push
      • Group Message
      • Message Formats
    • Account System
      • Login Authentication
      • Online Status Management
    • Group Related
      • Group System
      • Group Management
    • User Profile and Relationship Chain
      • Profile Management
      • Relationship Chain Management
  • Purchase Guide
    • Billing Overview
    • Pricing
  • Error Codes
Docs Overview/
Chat/
UIKit/
Flutter/
Features/
Local Search/

Local Search

Local search is implemented in TUIKit. It allows users to quickly find the expected information from massive amounts of complex data, such as the chat history, contacts, and group chats. It can also be used as an operations tool to easily and efficiently navigate to extensive content.
Note:
The "local search" feature is only available on the Ultimate edition of Tencent Cloud Chat. To use this feature, purchase the Ultimate edition. For more information, see Pricing.

Feature Demonstration

Component
Description
TIMUIKitSearch
Global search.
TIMUIKitSearchMsgDetail
In-conversation search, including searches in one-to-one chats and group chats.
The global search UI consists of three parts: the first part is for friend search, the second part is for group and group member search, and the third part is for message search, where messages are classified by conversation.

Integration Guide

The following introduces how to integrate the local components of TUIKit.

Purchasing the package

Import the following content to the global search page file:
/// Integrate the TIMUIKitSearch component
import 'package:tencent_cloud_chat_uikit/ui/views/TIMUIKitSearch/tim_uikit_search.dart';
Import the following content to the in-conversation search page file:
/// Integrate the TIMUIKitSearchMsgDetail component
import 'package:tencent_cloud_chat_uikit/ui/views/TIMUIKitSearch/tim_uikit_search_msg_detail.dart';

Global search page

TIMUIKitSearch is a global search component. In this component, search results are contacts, groups, and chat records that match search keywords. TIMUIKitSearch is usually placed above the message list. You can click it to open the global search component.
To view the sample code, see here.

In-conversation search page

TIMUIKitSearchMsgDetail is a chat information search component. In this component, search results are chat records that match search keywords. TIMUIKitSearchMsgDetail can be accessed via various entries, including:
Chat History on the global search page
Search Chat History on a user profile page
Search Chat History on a group profile page
To view the sample code, see here.

FAQs

1. How do I search for rich media messages?

Rich media messages include file, image, audio, and video messages. For a file message, the filename is usually displayed on the UI. Therefore, you can set the fileName parameter as the searched content when creating a file message. If fileName is not set, the system gets the filename from filePath and saves it to both the local device and the server. For an image, audio, or video message, the thumbnail or duration is usually displayed on the UI. In this case, you can specify the message type for search but cannot specify keywords for search.