AI Assistant Chat History

{
  "component": "CometChatAIAssistantChatHistory",
  "package": "com.cometchat.chatuikit.aiassistantchathistory",
  "xmlElement": "<com.cometchat.chatuikit.aiassistantchathistory.CometChatAIAssistantChatHistory />",
  "description": "Displays the conversation history between users and an AI assistant for easy review of past interactions.",
  "primaryOutput": {
    "method": "setOnItemClickListener",
    "type": "OnItemClickListener<BaseMessage>"
  },
  "methods": {
    "data": {
      "setUser": {
        "type": "User",
        "required": true,
        "note": "User must have role set to @agentic"
      }
    },
    "callbacks": {
      "setOnItemClickListener": "OnItemClickListener<BaseMessage>",
      "setOnItemLongClickListener": "OnItemLongClickListener<BaseMessage>",
      "setOnNewChatClickListener": "OnClick",
      "setOnCloseClickListener": "OnClick"
    },
    "visibility": {
      "setErrorStateVisibility": { "type": "int (View.VISIBLE | View.GONE)", "default": "View.VISIBLE" },
      "setEmptyStateVisibility": { "type": "int (View.VISIBLE | View.GONE)", "default": "View.VISIBLE" }
    },
    "style": {
      "setStyle": {
        "type": "@StyleRes int",
        "parent": "CometChatAIAssistantChatHistoryStyle"
      }
    }
  },
  "events": [],
  "sdkListeners": []
}

​

Quick Start

1. Open your layout XML file.
2. Add the CometChatAIAssistantChatHistory XML element:

<com.cometchat.chatuikit.aiassistantchathistory.CometChatAIAssistantChatHistory
    android:id="@+id/cometchat_ai_assistant_chat_history"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

What this does: Adds the CometChatAIAssistantChatHistory component to your layout. It fills the available width and height and renders the AI assistant chat history list.

3. In your Activity or Fragment, create a User object with the role set to @agentic and pass it to the component:

User user = new User();
user.setUid("userId");
user.setName("User Name");
user.setRole("@agentic"); // User role must be @agentic to use AI Assistant features

binding.cometChatAiAssistantChatHistory.setUser(user);

val user = User()
user.uid = "userId"
user.name = "User Name"
user.role = "@agentic" // User role must be @agentic to use AI Assistant features

binding.cometChatAiAssistantChatHistory.setUser(user)

What this does: Creates a User object with the @agentic role and sets it on the CometChatAIAssistantChatHistory component. This is required for the component to fetch and display the AI assistant chat histories for that user.

4. Build and run your app.
5. Verify that the AI assistant chat history list appears with past conversation items.

​

Core Concepts

• CometChatAIAssistantChatHistory: The main component class that renders the AI assistant chat history list. It is a Composite Component that can be launched via button clicks or any user-triggered action.
• Actions: Callbacks such as setOnItemClickListener, setOnItemLongClickListener, setOnNewChatClickListener, and setOnCloseClickListener that let you respond to user interactions.
• Style: XML theme styles applied via setStyle() to customize colors, fonts, and visual appearance of the chat history.
• Functionality: Methods like setUser, setErrorStateVisibility, and setEmptyStateVisibility that configure the component’s behavior and state visibility.

​

Actions and Events

​

Callback Methods

• Where: Activity or Fragment where you hold a reference to CometChatAIAssistantChatHistory.
• Applies to: CometChatAIAssistantChatHistory.
• Default behavior: Predefined actions execute automatically when the user interacts with the component.
• Override: Call the corresponding setter method to replace the default behavior with your own logic.

​

setOnItemClickListener

binding.cometchatAiAssistantChatHistory.setOnItemClickListener((view, position, message) -> {

        });

binding.cometchatAiAssistantChatHistory.setOnItemClickListener { view, position, message ->

        }

What this does: Replaces the default item-click behavior. When a user taps a chat history item, your custom lambda executes instead of the built-in navigation.

​

setOnItemLongClickListener

binding.cometchatAiAssistantChatHistory.setOnItemLongClickListener((view, position, message) -> {

        });

binding.cometchatAiAssistantChatHistory.setOnItemLongClickListener { view, position, message ->

        }

What this does: Replaces the default long-press behavior. When a user long-presses a chat history item, your custom lambda executes.

​

setOnNewChatClickListener

binding.cometchatAiAssistantChatHistory.setOnNewChatClickListener(() -> {

        });

binding.cometchatAiAssistantChatHistory.setOnNewChatClickListener {

        }

What this does: Replaces the default new-chat-click behavior. When the user taps the new chat button, your custom logic runs instead of the built-in action.

​

setOnCloseClickListener

binding.cometchatAiAssistantChatHistory.setOnCloseClickListener(() -> {

        });

binding.cometchatAiAssistantChatHistory.setOnCloseClickListener {

        }

What this does: Replaces the default close-click behavior. When the user taps the close button, your custom logic runs instead of the built-in exit action.

• Verify: After setting an action callback, trigger the corresponding user interaction (tap, long-press, new chat, close) and confirm your custom logic executes instead of the default behavior.

​

Styling

• Where: themes.xml for style definitions, and your Activity/Fragment for applying the style.
• Applies to: CometChatAIAssistantChatHistory.
• Default behavior: The component uses its default style.
• Override: Define a custom style in themes.xml, then call setStyle() on the component.

• Code:

<style name="CustomAIAssistantChatHistoryStyle">
    <item name="cometChatAIAssistantChatHistoryBackgroundColor">#FFFAF6</item>
    <item name="cometChatAIAssistantChatHistoryHeaderBackgroundColor">#FFFAF6</item>
    <item name="cometChatAIAssistantChatHistoryHeaderTextColor">?attr/cometchatTextColorPrimary</item>
    <item name="cometChatAIAssistantChatHistoryHeaderTextAppearance">@style/textStyleTimesNewRoman</item>
    <item name="cometChatAIAssistantChatHistoryNewChatBackgroundColor">#FFFAF6</item>
    <item name="cometChatAIAssistantChatHistoryNewChatTextColor">?attr/cometchatTextColorPrimary</item>
    <item name="cometChatAIAssistantChatHistoryNewChatTextAppearance">@style/textStyleTimesNewRoman</item>
    <item name="cometChatAIAssistantChatHistoryDateSeparatorTextAppearance">@style/textStyleTimesNewRoman</item>
    <item name="cometChatAIAssistantChatHistoryDateSeparatorTextColor">?attr/cometchatTextColorTertiary</item>
    <item name="cometChatAIAssistantChatHistoryDateSeparatorBackgroundColor">#FFFAF6</item>
    <item name="cometChatAIAssistantChatHistoryItemBackgroundColor">#FFFAF6</item>
    <item name="cometChatAIAssistantChatHistoryItemTextAppearance">@style/textStyleTimesNewRoman</item>
    <item name="cometChatAIAssistantChatHistoryItemTextColor">?attr/cometchatTextColorPrimary</item>
</style>

<style name="textStyleTimesNewRoman">
    <item name="android:fontFamily">@font/times_new_roman_regular</item>
</style>

What this does: Defines a custom style CustomAIAssistantChatHistoryStyle that sets the background color to #FFFAF6 for the component, header, new chat area, date separator, and items. It applies a Times New Roman font to the header, new chat text, date separator, and item text. A helper style textStyleTimesNewRoman defines the font family.

binding.cometchatAiAssistantChatHistory.setStyle(R.style.CustomAIAssistantChatHistoryStyle);

binding.cometchatAiAssistantChatHistory.setStyle(R.style.CustomAIAssistantChatHistoryStyle);

What this does: Applies the CustomAIAssistantChatHistoryStyle theme to the CometChatAIAssistantChatHistory component, changing the background colors and fonts.

• Verify: The chat history component displays with the #FFFAF6 background color and Times New Roman font for header text, new chat text, date separator text, and item text.

​

Functionality

• Where: Activity or Fragment where you hold a reference to CometChatAIAssistantChatHistory.
• Applies to: CometChatAIAssistantChatHistory.
• Default behavior: All UI states are visible with default settings.
• Override: Call the corresponding method on the component instance.

• Verify: After calling setUser(user), confirm the component fetches and displays the AI assistant chat histories for that user. After calling a visibility method, confirm the corresponding UI state is shown or hidden.

​

Customization Matrix

​

Next Steps