Skip to content

Android v6 Docs #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vivekCometChat wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Android v6 Docs #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 113 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1676,6 +1676,119 @@
}
]
},
{
"version": "v6‎‎‎",
"groups": [
{
"group": " ",
"pages": [
"ui-kit/android/v6/overview",
{
"group": "Getting Started",
"pages": [
"ui-kit/android/v6/getting-started",
"ui-kit/android/v6/getting-started-kotlin",
"ui-kit/android/v6/getting-started-jetpack",
"ui-kit/android/v6/one-to-one-chat",
"ui-kit/android/v6/tab-based-chat",
"ui-kit/android/v6/calling-integration"
]
},
{
"group": "Features",
"pages": [
{
"group": "Chat",
"pages": [
"ui-kit/android/v6/core-features",
"ui-kit/android/v6/extensions",
"ui-kit/android/v6/ai-features"
]
},
"ui-kit/android/v6/call-features"
]
},
{
"group": "Theming",
"pages": [
"ui-kit/android/v6/theme-introduction",
"ui-kit/android/v6/color-resources",
"ui-kit/android/v6/component-styling",
"ui-kit/android/v6/message-bubble-styling",
"ui-kit/android/v6/localize",
"ui-kit/android/v6/sound-manager"
]
},
{
"group": "Customization",
"pages": [
"ui-kit/android/v6/customization-overview",
"ui-kit/android/v6/customization-view-slots",
"ui-kit/android/v6/customization-styles",
"ui-kit/android/v6/customization-viewmodel-data",
"ui-kit/android/v6/customization-events",
"ui-kit/android/v6/customization-state-views",
"ui-kit/android/v6/customization-text-formatters",
"ui-kit/android/v6/customization-menu-options"
]
},
{
"group": "Components",
"pages": [
"ui-kit/android/v6/components-overview",
"ui-kit/android/v6/conversations",
"ui-kit/android/v6/conversation-message-view",
"ui-kit/android/v6/users",
"ui-kit/android/v6/groups",
"ui-kit/android/v6/group-members",
"ui-kit/android/v6/message-header",
"ui-kit/android/v6/message-list",
"ui-kit/android/v6/message-composer",
"ui-kit/android/v6/message-template",
"ui-kit/android/v6/threaded-messages-header",
"ui-kit/android/v6/incoming-call",
"ui-kit/android/v6/outgoing-call",
"ui-kit/android/v6/call-buttons",
"ui-kit/android/v6/call-logs"
]
},
{
"group": "Reference",
"pages": [
"ui-kit/android/v6/methods",
"ui-kit/android/v6/events"
]
},
{
"group": "Guides",
"pages": [
"ui-kit/android/v6/guide-overview",
"ui-kit/android/v6/guide-threaded-messages",
"ui-kit/android/v6/guide-block-unblock-user",
"ui-kit/android/v6/guide-new-chat",
"ui-kit/android/v6/guide-message-privately",
"ui-kit/android/v6/guide-call-log-details",
"ui-kit/android/v6/guide-group-chat",
"ui-kit/android/v6/custom-text-formatter-guide",
"ui-kit/android/v6/mentions-formatter-guide",
"ui-kit/android/v6/shortcut-formatter-guide"
]
},
"ui-kit/android/v6/architecture-data-flow",
{
"group": "Migration Guide",
"pages": [
"ui-kit/android/v6/upgrading-from-v5"
]
},
"ui-kit/android/v6/troubleshooting",
"ui-kit/android/v6/link/sample",
"ui-kit/android/v6/link/figma",
"ui-kit/android/v6/link/changelog"
]
}
]
},
{
"version": "v4‎‎‎",
"groups": [
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/android/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: "Overview"
description: "Prebuilt Android Views for chat, voice, and video calling. Supports Kotlin and Java with XML and Jetpack Compose compatibility."
---

<Note>
🚀 **CometChat Android UI Kit v6 is now available!** It features a completely revamped component architecture and improved theming. [Try the v6 →](/ui-kit/android/v6/overview)
</Note>

<Accordion title="AI Integration Quick Reference">

| Field | Value |
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/android/v2/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: "Overview"
---

<Note>
🚀 **CometChat Android UI Kit v6 is now available!** It features a completely revamped component architecture and improved theming. [Try the v6 →](/ui-kit/android/v6/overview)
</Note>

The CometChat Android Java UI Kit is developed to keep developers in mind and aims to reduce development efforts significantly.

<Frame>
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/android/v3/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: "Overview"
---

<Note>
🚀 **CometChat Android UI Kit v6 is now available!** It features a completely revamped component architecture and improved theming. [Try the v6 →](/ui-kit/android/v6/overview)
</Note>

<Note>
Reference for Kotlin UI Kit.

Expand Down
4 changes: 4 additions & 0 deletions ui-kit/android/v4/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: "Overview"
---

<Note>
🚀 **CometChat Android UI Kit v6 is now available!** It features a completely revamped component architecture and improved theming. [Try the v6 →](/ui-kit/android/v6/overview)
</Note>

With CometChat's UI Kit for Android, you can effortlessly build a chat app equipped with all the essential messaging features, along with customizable options tailored to your application requirements. This UI Kit comprises prebuilt UI components organized into smaller modules and components, each configurable to meet your specific needs.

<Frame>
Expand Down
59 changes: 59 additions & 0 deletions ui-kit/android/v6/ai-features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Smart Chat Features"
description: "Integrate AI-powered conversation starters, smart replies, and conversation summaries into your Android chat app."
---

<Accordion title="AI Integration Quick Reference">

| Field | Value |
| --- | --- |
| Packages | `com.cometchat:chat-uikit-android` (Java), `com.cometchat:chat-uikit-kotlin` (Kotlin XML), `com.cometchat:chat-uikit-compose` (Jetpack Compose) |
| Required setup | `CometChatUIKit.init()` then `CometChatUIKit.login()` + AI features enabled in [CometChat Dashboard](/fundamentals/ai-user-copilot/overview) |
| AI features | Conversation Starter, Smart Replies, Conversation Summary |
| Key components | [Message List](/ui-kit/android/v6/message-list) (Conversation Starter), [Message Composer](/ui-kit/android/v6/message-composer) (Smart Replies, Summary) |
| Activation | Enable each AI feature from the CometChat Dashboard — UI Kit auto-integrates them, no additional code required |
| Related | [Core Features](/ui-kit/android/v6/core-features), [Extensions](/ui-kit/android/v6/extensions), [AI Agent Guide](/ui-kit/android/v6/guide-ai-agent) |

</Accordion>

CometChat's AI capabilities greatly enhance user interaction and engagement in your application. Here's how the Android UI Kit integrates these features.

<Frame>
<img src="/images/dc468902-AI_Overview-0c7eccf3adcb1327d6a428bb2201419e.png" />
</Frame>

## Conversation Starter

When a user initiates a new chat, the UI kit displays a list of suggested opening lines that users can select, making it easier for them to start a conversation. These suggestions are powered by CometChat's AI, which predicts contextually relevant conversation starter options.

For a comprehensive understanding and guide on implementing and using the Conversation Starter, refer to our specific guide on the [Conversation Starter](/fundamentals/ai-user-copilot/conversation-starter).

Once you have successfully activated the [Conversation Starter](/fundamentals/ai-user-copilot/conversation-starter) from your CometChat Dashboard, the feature will automatically be incorporated into the [MessageList](/ui-kit/android/v6/message-list) Component of UI Kits.

<Frame>
<img src="/images/108f16f1-Conversation_Strater-0862a8398d19c4c886038595181016b2.png" />
</Frame>

## Smart Replies

Smart Replies are AI-generated responses to messages. They can predict what a user might want to say next by analyzing the context of the conversation. This allows for quicker and more convenient responses, especially on mobile devices.

For a comprehensive understanding and guide on implementing and using the Smart Replies, refer to our specific guide on the [Smart Replies](/fundamentals/ai-user-copilot/smart-replies).

Once you have successfully activated the [Smart Replies](/fundamentals/ai-user-copilot/smart-replies) from your CometChat Dashboard, the feature will automatically be incorporated into the Action sheet of [MessageComposer](/ui-kit/android/v6/message-composer) Component of UI Kits.

<Frame>
<img src="/images/c44db2a1-Smart_Reply-0a237e7f9625690ea90063914531b7ed.png" />
</Frame>

## Conversation Summary

The Conversation Summary feature provides concise summaries of long conversations, allowing users to catch up quickly on missed chats. This feature uses natural language processing to determine the main points in a conversation.

For a comprehensive understanding and guide on implementing and using the Conversation Summary, refer to our specific guide on the [Conversation Summary](/fundamentals/ai-user-copilot/conversation-summary).

Once you have successfully activated the [Conversation Summary](/fundamentals/ai-user-copilot/conversation-summary) from your CometChat Dashboard, the feature will automatically be incorporated into the Action sheet of [MessageComposer](/ui-kit/android/v6/message-composer) Component of UI Kits.

<Frame>
<img src="/images/25921821-Conversation_Summary-5b64b3eb0655bc79903ca520d40a1e15.png" />
</Frame>
Loading