tencent cloud

[keyName: string]: {
    key: string; // Specifies the key of the search message type, which must be unique.
    label: string; // Specifies the label for rendering search message type.
    value: Array<string>; // Specifies the actual search list for the search message type.
 };
 
 // For example, to search for custom messages
export const searchMessageTypeList = {
    ...
    customMessage: {
      key: "customMessage", // Specifies the key of the search message type, which must be unique.
      label: "Custom", // Specifies the label for rendering search message type.
      value: [TUIChatEngine.TYPES.MSG_CUSTOM], // Specifies the actual search list for the search message type.
    }
};

// For example, to apply the newly defined customMessage to the "Global Search" message type list
export const globalSearchTypeKeys = [..., "customMessage"];
// For example, to apply the newly defined customMessage to the "Search in conversation" message type list
export const conversationSearchTypeKeys = [..., "customMessage"];

[keyName: string]: {
    key: string; // Specifies the key of the message search time range, which must be unique.
    label: string; // Specifies the label for rendering the message search time range.
    value: { 
      timePosition: number; // Specifies the start position for message search time range. The default value is 0, indicating searching from the current time.
      timePeriod: number; // Specifies the time range to search backward from timePosition.
    };
};
 
 // For example, to search for messages in the time range of "last two days"
export const searchMessageTimeList = {
   ...
   twoDay: {
      key: "twoDay", // Specifies the key of the message search time range, which must be unique.
      label: "Two days", // Specifies the label for rendering the message search time range.
      value: {
        timePosition: 0, // Specifies the start position for message search time range. The default value is 0, indicating searching from the current time.
        timePeriod: 2 * oneDay; // Specifies the time range to search backward from timePosition.
      },
  },
};

chat.searchCloudMessages(options);

// Perform full search with specified keywords.
// - Search for messages containing 'hello' or 'where are you'
let promise = chat.searchCloudMessages({
   keywordList: ['hello', 'where are you']
});
promise.then(function(imResponse) {
 // Messages searched successfully.
   const { totalCount, cursor, searchResultList } = imResponse.data;
   console.log(totalCount); // Specifies the total number of conversations containing messages that meet the search criteria.
   console.log(cursor); // Specifies the start position for the next cloud search. If this parameter is not specified, the search results have been fully retrieved.
   console.log(searchResultList); // Messages that meet the search criteria are grouped by conversation ID, and the grouped results are returned by page.
   for (let i = 0; i < searchResultList.length; i++) {
      const searchResultItem = searchResultList[i];
      const { conversationID, messageCount, messageList } = searchResultItem;
      console.log(conversationID); // Specifies the conversation ID.
      console.log(messageCount); // Specifies the total number of messages that meet the criteria found in the current conversation.
      // In case of search in [all conversations], the number of messages loaded in messageList has the following two possibilities:
      // - If the number of messages matched in a conversation is greater than 1, then messageList will be empty. "messageCount records" can be displayed on the UI.
      // - If the number of messages matched in a conversation equals 1, then messageList is the matched message.
      // This message can be displayed on the UI and the matching keywords are highlighted.
      console.log(messageList);
    }
}).catch(function(imError) {
   console.error(imError); // Failed to search for messages.
});