diff --git a/ui-kit/android/conversations.mdx b/ui-kit/android/conversations.mdx index ddf40063..086d6a2d 100644 --- a/ui-kit/android/conversations.mdx +++ b/ui-kit/android/conversations.mdx @@ -459,8 +459,9 @@ Below is a list of customizations along with corresponding code snippets | disableSoundForMessages | This method disables sound notifications for incoming messages | `.disableSoundForMessages(true);` | | setCustomSoundForMessages | This method enables users to personalize their chat experience by setting a custom sound file for incoming message notifications. | `.setCustomSoundForMessages(com.cometchat.chatuikit.R.raw.cometchat_beep2);` | | setSelectionMode | This method determines the selection mode for conversations, enabling users to select either a single conversation or multiple conversations at once. | `.setSelectionMode(UIKitConstants.SelectionMode.MULTIPLE);` | -| setSearchInputText | This method sets the text in the search input field. | .setSearchInputText("Sample Text"); | -| setSearchPlaceholderText | This method sets the placeholder text for the search input field. | .setSearchPlaceholderText("Enter search term"); | +| setSearchInputText | This method sets the text in the search input field. | `.setSearchInputText("Sample Text");` | +| setSearchPlaceholderText | This method sets the placeholder text for the search input field. | `.setSearchPlaceholderText("Enter search term");` | +| setMentionAllLabelId | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabelId("Id", "Label")` | ### Advanced diff --git a/ui-kit/android/core-features.mdx b/ui-kit/android/core-features.mdx index 3dc1732f..1eaf1a5a 100644 --- a/ui-kit/android/core-features.mdx +++ b/ui-kit/android/core-features.mdx @@ -95,7 +95,7 @@ CometChat's Reactions feature adds a layer of expressiveness to your chat applic ## Mentions -Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation. +Mentions is a robust feature provided by CometChat that enhances the interactivity and clarity of group or 1-1 chats by allowing users to directly address or refer to specific individuals in a conversation. The feature also supports group mentions like @all, enabling users to quickly notify all members in a group chat simultaneously. diff --git a/ui-kit/android/message-composer.mdx b/ui-kit/android/message-composer.mdx index ca7e8ae2..a25ecc96 100644 --- a/ui-kit/android/message-composer.mdx +++ b/ui-kit/android/message-composer.mdx @@ -250,6 +250,8 @@ Below is a list of customizations along with corresponding code snippets | **setPollAttachmentOptionVisibility** | Controls whether polls can be shared | `.setPollAttachmentOptionVisibility(View.VISIBLE)` | | **setCollaborativeDocumentOptionVisibility** | Controls whether collaborative documents can be shared | `.setCollaborativeDocumentOptionVisibility(View.VISIBLE)` | | **setCollaborativeWhiteboardOptionVisibility** | Controls whether collaborative whiteboards can be shared | `.setCollaborativeWhiteboardOptionVisibility(View.VISIBLE)` | +| **setDisableMentionAll** | Controls whether group mentions like @all appear in suggestions. | `.setDisableMentionAll(true)` | +| **setMentionAllLabelId** | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabelId("Id", "Label")` | *** diff --git a/ui-kit/android/message-list.mdx b/ui-kit/android/message-list.mdx index cb972b76..99cb125f 100644 --- a/ui-kit/android/message-list.mdx +++ b/ui-kit/android/message-list.mdx @@ -442,14 +442,18 @@ Below is a list of customizations along with corresponding code snippets | **groupActionMessageVisibility** | used to toggle visibility for action message option | `.groupActionMessageVisibility(View.GONE);` | | **enableConversationStarters** | Controls whether conversation starters are generated in new conversations | `.enableConversationStarters(true);` | | **setEnableConversationSummary** | Controls whether conversation summaries are enabled for the conversation list. | `.setEnableConversationSummary(true);` | -| **setUnreadMessageThreshold** | Sets the threshold for unread messages, determining when a message is marked as unread. | .setUnreadMessageThreshold(10); | -| **setSwipeToReplyEnabled** | Controls whether the swipe-to-reply functionality is enabled or disabled for messages. | .setSwipeToReplyEnabled(true); | +| **setUnreadMessageThreshold** | Sets the threshold for unread messages, determining when a message is marked as unread. | `.setUnreadMessageThreshold(10);` | +| **setSwipeToReplyEnabled** | Controls whether the swipe-to-reply functionality is enabled or disabled for messages. | `.setSwipeToReplyEnabled(true);` | | **enableSmartReplies** | Enables smart replies for quick responses | `.enableSmartReplies(true);` | | **smartRepliesKeywords** | Defines 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"));` | | **smartRepliesDelayDuration** | Sets the delay time before Smart Replies are fetched and displayed after a message is received. | `.smartRepliesDelayDuration(5000);` | | **setAiAssistantSuggestedMessagesVisibility** | used to toggle visibility for suggested messages in case of chats with AI Assistants | `.setAiAssistantSuggestedMessagesVisibility(View.GONE);` | | **setAIAssistantEmptyStateVisibility** | used to toggle visibility for empty chat greeting view in case of chats with AI Assistants | `.setAIAssistantEmptyStateVisibility(View.GONE);` | | **refreshStyle** | used to refresh the style of message list | `.refreshStyle();` | +| **generateConversationSummary** | Triggers the generation of a conversation summary by fetching it from the ViewModel. | `.generateConversationSummary();` | +| **setReplyOptionVisibility** | Sets the visibility of the “Reply to Message” option in the message actions menu. | `.setReplyOptionVisibility(View.VISIBLE);` | +| **setReportOptionVisibility** | Sets the visibility of the “Report” option in the message actions menu. | `.setReportOptionVisibility(View.VISIBLE);` | +| **setMentionAllLabelId** | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabelId("Id", "Label")` | | **generateConversationSummary** | Triggers the generation of a conversation summary by fetching it from the ViewModel. | .generateConversationSummary(); | | **setReplyOptionVisibility** | Sets the visibility of the “Reply to Message” option in the message actions menu. | .setReplyOptionVisibility(View.VISIBLE); | | **setFlagOptionVisibility** | Sets the visibility of the “Report” option in the message actions menu. | .setFlagOptionVisibility(View.VISIBLE); | diff --git a/ui-kit/android/search.mdx b/ui-kit/android/search.mdx index 5377979a..7c25c6f2 100644 --- a/ui-kit/android/search.mdx +++ b/ui-kit/android/search.mdx @@ -355,17 +355,18 @@ Below is a list of customizations along with corresponding code snippets | Property | Description | Code | | ------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| **User** | The UID of the user in whose conversation the search will be performed. | `.setUid(String uid)` | -| **Group** | The GUID of the group in whose conversation the search will be performed. | `.setGuid(String guid)` | -| **Hide User Status** | Hides the user's online/offline status indicator. | `.setHideUserStatus(boolean bool)` | -| **Hide Group Type** | Hides the group type icon in conversation leading view. | `.setHideGroupType(boolean hide)` | -| **Search Filters** | List of filters to be rendered in the Search component. | `.setSearchFilters(List filters)` | -| **Initial Search Filter** | The filter which will be active by default on load. | `.setInitialSearchFilter(UIKitConstants.SearchFilter initialSearchFilter)` | -| **Search In** | List of entities in which the search should be performed. | `.setSearchIn(List scopes)` | -| **Initial View** | Custom view to be shown when CometChat Search is rendered & no search is performed. | `.setInitialView(@LayoutRes int initialView)` | -| **Loading View** | A custom component to display during the loading state. | `.setLoadingView(View loadingView)` | -| **Empty View** | A custom component to display when there are no conversations available. | `.setEmptyView(@LayoutRes int emptyView)` | -| **Error View** | A custom component to display when an error occurs. | `.setErrorView(View errorView)` | +| **User** | The UID of the user in whose conversation the search will be performed. | `.setUid(String uid)` | +| **Group** | The GUID of the group in whose conversation the search will be performed. | `.setGuid(String guid)` | +| **Hide User Status** | Hides the user's online/offline status indicator. | `.setHideUserStatus(boolean bool)` | +| **Hide Group Type** | Hides the group type icon in conversation leading view. | `.setHideGroupType(boolean hide)` | +| **Search Filters** | List of filters to be rendered in the Search component. | `.setSearchFilters(List filters)` | +| **Initial Search Filter** | The filter which will be active by default on load. | `.setInitialSearchFilter(UIKitConstants.SearchFilter initialSearchFilter)` | +| **Search In** | List of entities in which the search should be performed. | `.setSearchIn(List scopes)` | +| **Initial View** | Custom view to be shown when CometChat Search is rendered & no search is performed. | `.setInitialView(@LayoutRes int initialView)` | +| **Loading View** | A custom component to display during the loading state. | `.setLoadingView(View loadingView)` | +| **Empty View** | A custom component to display when there are no conversations available. | `.setEmptyView(@LayoutRes int emptyView)` | +| **Error View** | A custom component to display when an error occurs. | `.setErrorView(View errorView)` | +| **setMentionAllLabelId** | Allows setting a custom alias label for group mentions (@channel, @everyone, etc.). | `.setMentionAllLabelId("Id", "Label")` | ### Advanced