Skip to main content
Version: v5

Message List

Overview

MessageList is a Composite Component that displays a list of messages and effectively manages real-time operations. It includes various types of messages such as Text Messages, Media Messages, Stickers, and more.

MessageList is primarily a list of the base component MessageBubble. The MessageBubble Component is utilized to create different types of chat bubbles depending on the message type.

Image

Usage

Integration

The following code snippet illustrates how you can directly incorporate the MessageList component into your layout.xml file.

<com.cometchat.chatuikit.messagelist.CometChatMessageList
android:id="@+id/message_list"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_marginStart="16dp"
android:layout_marginEnd="16dp"
android:background="@android:color/transparent" />
warning

Simply adding the MessageList component to the layout will only display the loading indicator. To fetch messages for a specific entity, you need to supplement it with User or Group Object.


Actions

Actions dictate how a component functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.

1. onThreadRepliesClick

onThreadRepliesClick is triggered when you click on the threaded message bubble. The onThreadRepliesClick action doesn't have a predefined behavior. You can override this action using the following code snippet.

cometchatMessageList.setOnThreadRepliesClick((context, baseMessage, cometchatMessageTemplate) -> {

});
2. onError

This action doesn't change the behavior of the component but rather listens for any errors that occur in the MessageList component.

YourActivity.java
cometchatMessageList.setOnError(new OnError() {
@Override
public void onError(CometChatException e) {
//Your Exception Handling code.
}
});

setOnLoad

Invoked when the list is successfully fetched and loaded, helping track component readiness.

YourActivity.java
cometchatMessageList.setOnLoad(list -> {

});

setOnEmpty

Called when the list is empty, enabling custom handling such as showing a placeholder message.

YourActivity.java
cometchatMessageList.setOnEmpty(() -> {

});

onReactionLongClick

Function triggered when a user long presses on a reaction pill, allowing developers to override the default behavior.

YourActivity.java
cometchatMessageList.setOnReactionLongClick((emoji, baseMessage) -> {

});

onAddMoreReactionsClick

Function triggered when a user clicks on the 'Add More Reactions' button, allowing developers to handle this action.

YourActivity.java
cometchatMessageList.setOnAddMoreReactionsClick(baseMessage -> {

});

onReactionClick

Function triggered when a reaction is clicked, enabling developers to customize reaction interactions.

YourActivity.java
cometchatMessageList.setOnReactionClick((emoji, baseMessage) -> {

});

setOnReactionListItemClick

Function triggered when a reaction list item is clicked, allowing developers to override its behavior in CometChatReactionsList.

YourActivity.java
cometchatMessageList.setOnReactionListItemClick((reaction, message) -> {

});

Filters

You can adjust the MessagesRequestBuilder in the MessageList Component to customize your message list. Numerous options are available to alter the builder to meet your specific needs. For additional details on MessagesRequestBuilder, please visit MessagesRequestBuilder.

In the example below, we are applying a filter to the messages based on a search substring and for a specific user. This means that only messages that contain the search term and are associated with the specified user will be displayed

MessagesRequest.MessagesRequestBuilder messagesRequest = new MessagesRequest.MessagesRequestBuilder()
.setSearchKeyword("your search keyword")
.setUID("user uid");

messageList.setMessagesRequestBuilder(messagesRequest);
info

The following parameters in messageRequestBuilder will always be altered inside the message list

  1. UID
  2. GUID
  3. types
  4. categories

Events

Events are emitted by a Component. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed.

The MessageList Component does not emit any events of its own.


Customization

To fit your app's design requirements, you can customize the appearance of the conversation component. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.

Style

Using Style you can customize the look and feel of the component in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the component.

Image
    <style name="CustomOutgoingMessageBubbleStyle" parent="CometChatOutgoingMessageBubbleStyle">
<item name="cometchatMessageBubbleBackgroundColor">#F76808</item>
</style>

<style name="CustomCometChatMessageListStyle" parent="CometChatMessageListStyle">
<item name="cometchatMessageListBackgroundColor">#FEEDE1</item>
<item name="cometchatMessageListOutgoingMessageBubbleStyle">@style/CustomOutgoingMessageBubbleStyle</item>
</style>
cometChatMessageList.setStyle(R.style.CustomCometChatMessageListStyle);

To know more such attributes, visit the attributes file.

Functionality

These are a set of small functional customizations that allow you to fine-tune the overall experience of the component. With these, you can change text, set custom icons, and toggle the visibility of UI elements.

CometChatMessageList cometChatMessageList = findViewById(R.id.message_list);
cometChatMessageList.setUser(user);
cometChatMessageList.hideError(true);
cometChatMessageList.hideReceipt(true);

Below is a list of customizations along with corresponding code snippets

Image
PropertyDescriptionCode
setUserUsed to pass user object of which header specific details will be shown.setUser(user);
setGroupUsed to pass group object of which header specific details will be shown.setGroup(Group);
setAlignmentused to set the alignmet of messages in CometChatMessageList. It can be either leftAligned or standard.setAlignment(UIKitConstants.MessageListAlignment);
setErrorStateVisibilityused to toggle visibility of error state in MessageList.setErrorStateVisibility(View.GONE);
disableSoundForMessagesused to enable/disable sound for incoming/outgoing messages , default false.disableSoundForMessages(false);
setCustomSoundForMessagesused to set custom sound for outgoing message.setCustomSoundForMessages(@RawRes resource);
setAvatarVisibilityused to toggle visibility for avatar.setAvatarVisibility(View.GONE);
scrollToBottomOnNewMessageshould scroll to bottom on new message? , by default false.scrollToBottomOnNewMessage(true);
setReceiptsVisibilityUsed to control visibility of read receipts without disabling the functionality of marking messages as read and delivered..setReceiptsVisibility(View.GONE);
setQuickReactionsThe list of quick reactions to be set.This list will replace the predefined set of reactions.setQuickReactions(Arrays.asList("👻","😈","🙀","🤡","❤️");
setStickyDateVisibilityused to toggle visibility for sticky header.setStickyDateVisibility(View.GONE);
replyInThreadOptionVisibilityused to toggle visibility for thread option.replyInThreadOptionVisibility(View.GONE);
translateMessageOptionVisibilityused to toggle visibility for translate option.translateMessageOptionVisibility(View.GONE);
editMessageOptionVisibilityused to toggle visibility for edit option.editMessageOptionVisibility(View.GONE);
deleteMessageOptionVisibilityused to toggle visibility for delete option.deleteMessageOptionVisibility(View.GONE);
setMessageReactionOptionVisibilityused to toggle visibility for reaction option.setMessageReactionOptionVisibility(View.GONE);
messagePrivatelyOptionVisibilityused to toggle visibility for private option.messagePrivatelyOptionVisibility(View.GONE);
copyMessageOptionVisibilityused to toggle visibility for copy option.copyMessageOptionVisibility(View.GONE);
messageInfoOptionVisibilityused to toggle visibility for info option.messageInfoOptionVisibility(View.GONE);
groupActionMessageVisibilityused to toggle visibility for action message option.groupActionMessageVisibility(View.GONE);
enableConversationStartersControls whether conversation starters are generated in new conversations.enableConversationStarters(true);
enableSmartRepliesEnables smart replies for quick responses.enableSmartReplies(true);
smartRepliesKeywordsDefines specific keywords in an incoming message that will trigger Smart Replies..setAISmartRepliesKeywords(Arrays.asList("hello", "hi", "how are you", "good morning", "good evening", "good night"));
smartRepliesDelayDurationSets the delay time before Smart Replies are fetched and displayed after a message is received..smartRepliesDelayDuration(5000);

Advance

For advanced-level customization, you can set custom views to the component. This lets you tailor each aspect of the component to fit your exact needs and application aesthetics. You can create and define your views, layouts, and UI elements and then incorporate those into the component.

SetTemplate

CometChatMessageTemplate is a pre-defined structure for creating message views that can be used as a starting point or blueprint for creating message views often known as message bubbles. For more information, you can refer to CometChatMessageTemplate.

setDateFormat

Specifies a custom format for displaying sticky date separators in the chat.

Use Cases:

  • Customize date formats to match regional preferences.
  • Use relative formats like "Yesterday" instead of full dates.
  • Highlight weekend conversations with different styles.
messageList.setDateFormat(new SimpleDateFormat("MMM dd, yyyy",Locale.getDefault()));

setTimeFormat

Defines the format in which time appears for each message bubble.

Use Cases:

  • Use 12-hour or 24-hour formats based on user preference.
  • Display relative time ("Just now", "5 min ago").
  • Add AM/PM indicators for clarity.
messageList.setTimeFormat(new SimpleDateFormat("hh:mm a",Locale.getDefault()));

setLoadingView

Customizes the loading indicator when messages are being fetched.

Use Cases:

  • Show a spinner or skeleton loader for smooth UX.
  • Display a "Fetching messages..." text.
cometchatMessageList.setLoadingView(R.layout.your_loading_view);

setEmptyView

Defines a custom view to be displayed when no messages are available.

Use Cases:

  • Show a friendly message like "No messages yet. Start the conversation!".
cometchatMessageList.setEmptyView(R.layout.your_empty_view);

setErrorView

Custom error state view displayed when fetching messages fails.

Use Cases:

  • Show a retry button when an error occurs.
  • Display a friendly message like "Couldn't load messages. Check your connection.".
cometchatMessageList.setErrorView(R.layout.your_empty_view);

setTextFormatters

Assigns the list of text formatters. If the provided list is not null, it sets the list. Otherwise, it assigns the default text formatters retrieved from the data source. To configure the existing Mentions look and feel check out MentionsFormatter Guide Example

Image
themes.xml
<style name="CustomIncomingMessageBubbleMentionStyle" parent="CometChatIncomingBubbleMentionsStyle">
<item name="cometchatMentionTextAppearance">?attr/cometchatTextAppearanceBodyRegular</item>
<item name="cometchatMentionTextColor">#D6409F</item>
<item name="cometchatMentionBackgroundColor">#D6409F</item>
<item name="cometchatSelfMentionTextColor">#30A46C</item>
<item name="cometchatSelfMentionTextAppearance">?attr/cometchatTextAppearanceBodyRegular</item>
<item name="cometchatSelfMentionBackgroundColor">#30A46C</item>
</style>

<style name="CustomOutgoingMessageBubbleMentionStyle" parent="CometChatOutgoingBubbleMentionsStyle">
<item name="cometchatMentionTextAppearance">?attr/cometchatTextAppearanceBodyRegular</item>
<item name="cometchatMentionTextColor">#FFFFFF</item>
<item name="cometchatMentionBackgroundColor">#F9F8FD</item>
<item name="cometchatSelfMentionTextColor">#30A46C</item>
<item name="cometchatSelfMentionTextAppearance">?attr/cometchatTextAppearanceBodyRegular</item>
<item name="cometchatSelfMentionBackgroundColor">#30A46C</item>
</style>

// Initialize CometChatMentionsFormatter
CometChatMentionsFormatter mentionFormatter = new CometChatMentionsFormatter(context);

//set style to customize bubble mention text
mentionFormatter.setOutgoingBubbleMentionTextStyle(context, R.style.CustomOutgoingMessageBubbleMentionStyle);

mentionFormatter.setIncomingBubbleMentionTextStyle(context, R.style.CustomIncomingMessageBubbleMentionStyle);

// This can be passed as an array of formatter in CometChatMessageList by using setTextFormatters method.
List<CometChatTextFormatter> textFormatters = new ArrayList<>();
textFormatters.add(mentionFormatter);
messageList.setTextFormatters(textFormatters);

setHeaderView

This method allows you to set a custom header view for the message list. By providing a View object, you can customize the appearance and content of the header displayed at the top of the message list.

Use Cases:

  • Add a custom branding/logo to the chat.
  • Display chat status ("John is typing...").
  • Show last seen status.
cometChatMessageList.setHeaderView(view);

Example

Image
custom_header_layout.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="#EDEAFA"
android:orientation="horizontal">

<com.google.android.material.card.MaterialCardView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_4"
android:layout_marginTop="@dimen/cometchat_margin_1"
android:layout_marginBottom="@dimen/cometchat_margin_1"
android:elevation="0dp"
app:cardCornerRadius="@dimen/cometchat_radius_max"
app:cardElevation="0dp"
app:strokeColor="?attr/cometchatStrokeColorLight"
app:strokeWidth="1dp">

<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_padding_3"
android:layout_marginTop="@dimen/cometchat_padding_1"
android:layout_marginEnd="@dimen/cometchat_padding_3"
android:layout_marginBottom="@dimen/cometchat_padding_1"
android:gravity="center_vertical"
android:orientation="horizontal">

<ImageView
android:layout_width="20dp"
android:layout_height="@dimen/cometchat_20dp"
android:src="@drawable/cometchat_ic_file_upload"
app:tint="?attr/cometchatPrimaryColor" />

<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_1"
android:text="Notes"
android:textAppearance="?attr/cometchatTextAppearanceCaption1Regular"
android:textColor="?attr/cometchatPrimaryColor" />
</LinearLayout>
</com.google.android.material.card.MaterialCardView>

<com.google.android.material.card.MaterialCardView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_4"
android:layout_marginTop="@dimen/cometchat_margin_1"
android:layout_marginBottom="@dimen/cometchat_margin_1"
android:elevation="0dp"
app:cardCornerRadius="@dimen/cometchat_radius_max"
app:cardElevation="0dp"
app:strokeColor="?attr/cometchatStrokeColorLight"
app:strokeWidth="1dp">

<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_padding_3"
android:layout_marginTop="@dimen/cometchat_padding_1"
android:layout_marginEnd="@dimen/cometchat_padding_3"
android:layout_marginBottom="@dimen/cometchat_padding_1"
android:gravity="center_vertical"
android:orientation="horizontal">

<ImageView
android:layout_width="20dp"
android:layout_height="@dimen/cometchat_20dp"
android:src="@drawable/src_icons_pin"
app:tint="?attr/cometchatPrimaryColor" />

<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_1"
android:text="Pinned Messages"
android:textAppearance="?attr/cometchatTextAppearanceCaption1Regular"
android:textColor="?attr/cometchatPrimaryColor" />
</LinearLayout>
</com.google.android.material.card.MaterialCardView>

<com.google.android.material.card.MaterialCardView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_4"
android:layout_marginTop="@dimen/cometchat_margin_1"
android:layout_marginBottom="@dimen/cometchat_margin_1"
android:elevation="0dp"
app:cardCornerRadius="@dimen/cometchat_radius_max"
app:cardElevation="0dp"
app:strokeColor="?attr/cometchatStrokeColorLight"
app:strokeWidth="1dp">

<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_padding_3"
android:layout_marginTop="@dimen/cometchat_padding_1"
android:layout_marginEnd="@dimen/cometchat_padding_3"
android:layout_marginBottom="@dimen/cometchat_padding_1"
android:gravity="center_vertical"
android:orientation="horizontal">

<ImageView
android:layout_width="20dp"
android:layout_height="@dimen/cometchat_20dp"
android:src="@drawable/cometchat_link_file_icon"
app:tint="?attr/cometchatPrimaryColor" />

<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_1"
android:text="Saved Links"
android:textAppearance="?attr/cometchatTextAppearanceCaption1Regular"
android:textColor="?attr/cometchatPrimaryColor" />
</LinearLayout>
</com.google.android.material.card.MaterialCardView>

</LinearLayout>

cometChatMessageList.setHeaderView(View.inflate(getContext(), R.layout.custom_header_layout, null));

setFooterView

This method allows you to set a custom footer view for the message list. By providing a View object, you can customize the appearance and content of the footer displayed at the bottom of the message list.

Use Cases:

  • Add quick reply buttons.
  • Display typing indicators ("John is typing...").
  • Show a disclaimer or privacy notice.
cometChatMessageList.setFooterView(view);

Example

Image
custom_footer_layout.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="#EDEAFA"
android:orientation="horizontal">

<com.google.android.material.card.MaterialCardView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_4"
android:layout_marginTop="@dimen/cometchat_margin_1"
android:layout_marginBottom="@dimen/cometchat_margin_1"
android:elevation="0dp"
app:cardCornerRadius="@dimen/cometchat_radius_max"
app:cardElevation="0dp"
app:strokeColor="?attr/cometchatStrokeColorLight"
app:strokeWidth="1dp">

<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_padding_3"
android:layout_marginTop="@dimen/cometchat_padding_1"
android:layout_marginEnd="@dimen/cometchat_padding_3"
android:layout_marginBottom="@dimen/cometchat_padding_1"
android:gravity="center_vertical"
android:orientation="horizontal">

<ImageView
android:layout_width="20dp"
android:layout_height="@dimen/cometchat_20dp"
android:src="@drawable/cometchat_ic_file_upload"
app:tint="?attr/cometchatPrimaryColor" />

<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_1"
android:text="Notes"
android:textAppearance="?attr/cometchatTextAppearanceCaption1Regular"
android:textColor="?attr/cometchatPrimaryColor" />
</LinearLayout>
</com.google.android.material.card.MaterialCardView>

<com.google.android.material.card.MaterialCardView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_4"
android:layout_marginTop="@dimen/cometchat_margin_1"
android:layout_marginBottom="@dimen/cometchat_margin_1"
android:elevation="0dp"
app:cardCornerRadius="@dimen/cometchat_radius_max"
app:cardElevation="0dp"
app:strokeColor="?attr/cometchatStrokeColorLight"
app:strokeWidth="1dp">

<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_padding_3"
android:layout_marginTop="@dimen/cometchat_padding_1"
android:layout_marginEnd="@dimen/cometchat_padding_3"
android:layout_marginBottom="@dimen/cometchat_padding_1"
android:gravity="center_vertical"
android:orientation="horizontal">

<ImageView
android:layout_width="20dp"
android:layout_height="@dimen/cometchat_20dp"
android:src="@drawable/src_icons_pin"
app:tint="?attr/cometchatPrimaryColor" />

<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_1"
android:text="Pinned Messages"
android:textAppearance="?attr/cometchatTextAppearanceCaption1Regular"
android:textColor="?attr/cometchatPrimaryColor" />
</LinearLayout>
</com.google.android.material.card.MaterialCardView>

<com.google.android.material.card.MaterialCardView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_4"
android:layout_marginTop="@dimen/cometchat_margin_1"
android:layout_marginBottom="@dimen/cometchat_margin_1"
android:elevation="0dp"
app:cardCornerRadius="@dimen/cometchat_radius_max"
app:cardElevation="0dp"
app:strokeColor="?attr/cometchatStrokeColorLight"
app:strokeWidth="1dp">

<LinearLayout
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_padding_3"
android:layout_marginTop="@dimen/cometchat_padding_1"
android:layout_marginEnd="@dimen/cometchat_padding_3"
android:layout_marginBottom="@dimen/cometchat_padding_1"
android:gravity="center_vertical"
android:orientation="horizontal">

<ImageView
android:layout_width="20dp"
android:layout_height="@dimen/cometchat_20dp"
android:src="@drawable/cometchat_link_file_icon"
app:tint="?attr/cometchatPrimaryColor" />

<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="@dimen/cometchat_margin_1"
android:text="Saved Links"
android:textAppearance="?attr/cometchatTextAppearanceCaption1Regular"
android:textColor="?attr/cometchatPrimaryColor" />
</LinearLayout>
</com.google.android.material.card.MaterialCardView>

</LinearLayout>

cometChatMessageList.setFooterView(View.inflate(getContext(), R.layout.custom_footer_layout, null));