Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ __pycache__/
/docs-comparison-tool
/node_modules
/legacy-docs
AGENTS.md
4 changes: 2 additions & 2 deletions ai-agents/mastra-backend-tools-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Core files and folders for the Backend Tools Agent (browse source on GitHub):
- Server
- [src/mastra/index.ts](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-backend-tools-agent/src/mastra/index.ts)
- Workflows
- [src/mastra/workflows/index.ts](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-backend-tools-agent/src/mastra/workflows/index.ts)
- [src/mastra/workflows/orchestrator-workflow.ts](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-orchestrator-agent/src/mastra/workflows/orchestrator-workflow.ts)

***

Expand Down Expand Up @@ -191,4 +191,4 @@ curl -X POST http://localhost:4111/api/agents/deals/generate \

* Add more backend tools (e.g., get-order, create-ticket) and guard with RBAC.
* Stream responses or add partial updates for long-running actions.
* Instrument and log tool invocations for tuning and observability.
* Instrument and log tool invocations for tuning and observability.
6 changes: 0 additions & 6 deletions ai-agents/mastra-frontend-actions-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,6 @@ Give your chats superpowers: let an agent trigger visual effects and UI actions
Frontend sample
- [widget/index.html](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-frontend-actions-agent/widget/index.html)
- This keeps sensitive work on the server and visual effects on the client.
Workflows
- [src/mastra/workflows/index.ts](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-frontend-actions-agent/src/mastra/workflows/index.ts)

Key components (source-linked below): the agent, the `confetti` tool, server entry, and a sample widget page.

***
Expand All @@ -76,9 +73,6 @@ Key components (source-linked below): the agent, the `confetti` tool, server ent
- [src/mastra/index.ts](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-frontend-actions-agent/src/mastra/index.ts)
- Frontend sample
- [widget/index.html](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-frontend-actions-agent/widget/index.html)
- Workflows
- [src/mastra/workflows/index.ts](https://github.com/cometchat/ai-agent-mastra-examples/blob/main/mastra-frontend-actions-agent/src/mastra/workflows/index.ts)

***

## Step 1 - Create the Agent
Expand Down
2 changes: 1 addition & 1 deletion chat-builder/android/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CometChat UI Kit Builder For Android"
sidebarTitle: "Overview"
description: "CometChat UI Kit Builder for Android provides a pre-built user interface kit that developers can use to quickly integrate a reliable & fully-featured chat experience into an existing or a new app."
description: "CometChat UI Kit Builder for Android provides a pre-built interface to integrate a reliable, fully-featured chat experience into new or existing apps."
---

The CometChat UI Kit Builder for Android provides a pre-built user interface kit that developers can use to quickly integrate a reliable & fully-featured chat experience into an existing or a new app.
Expand Down
4 changes: 2 additions & 2 deletions chat-builder/flutter/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CometChat UI Kit Builder For Flutter"
sidebarTitle: "Overview"
description: "CometChat UI Kit Builder for Flutter is a visual development tool that helps you design and configure chat experiences for Flutter applications without building the interface from scratch."
description: "CometChat UI Kit Builder for Flutter provides a pre-built interface to integrate a reliable, fully-featured chat experience into new or existing apps."
---

It provides a set of prebuilt, production-ready messaging components backed by CometChat's real-time infrastructure.
Expand Down Expand Up @@ -137,5 +137,5 @@ Experience the CometChat UI Kit Builder in action:

## Need Help?

- Developer Community: http://community.cometchat.com/
- Developer Community: https://community.cometchat.com/
- Support Portal: https://help.cometchat.com/hc/en-us/requests/new
4 changes: 2 additions & 2 deletions chat-builder/ios/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CometChat UI Kit Builder For iOS"
sidebarTitle: "Overview"
description: "CometChat UI Kit Builder for iOS provides a pre-built user interface that developers can use to quickly integrate a reliable & fully-featured chat experience into an existing or new iOS app."
description: "CometChat UI Kit Builder for iOS provides a pre-built interface to integrate a reliable, fully-featured chat experience."
---

The CometChat iOS UI Kit provides a pre-built user interface that developers can use to quickly integrate a reliable & fully-featured chat experience into an existing or new iOS app using **UI Kit Builder** configuration.
Expand Down Expand Up @@ -98,4 +98,4 @@ Experience the CometChat UI Kit Builder in action:
<Card title="Create Support Ticket" href="https://help.cometchat.com/hc/en-us/requests/new">
Get assistance from our support team with any questions or issues
</Card>
</CardGroup>
</CardGroup>
2 changes: 1 addition & 1 deletion chat-builder/nextjs/integration.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "UI Kit Builder Integration"
sidebarTitle: "Integration"
description: "Step-by-step guide to integrating CometChat's UI Kit Builder into your Next.js application, including initialization, user login, SSR handling, and rendering the CometChatApp component."
description: "Step-by-step guide to integrating CometChat UI Kit Builder into your Next.js app with user login and SSR handling."
---

The **UI Kit Builder** simplifies integrating CometChat's UI Kit into your Next.js application — quickly set up chat, customize UI elements, and add features without extensive coding.
Expand Down
2 changes: 1 addition & 1 deletion chat-builder/nextjs/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CometChat UI Kit Builder For Next.js"
sidebarTitle: "Overview"
description: "CometChat UI Kit Builder for Next.js is a visual development tool that helps you design and configure chat experiences for Next.js applications without building the interface from scratch."
description: "CometChat UI Kit Builder for Next.js is a low-code development tool to design and configure fully-featured chat experiences."
---

It provides a set of prebuilt, production-ready messaging components backed by CometChat's real-time infrastructure.
Expand Down
2 changes: 1 addition & 1 deletion chat-builder/react-native/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,6 @@ Drop the configuration into your React Native project, add your CometChat creden

## Need Help?

- Developer Community: http://community.cometchat.com/
- Developer Community: https://community.cometchat.com/
- Dashboard & Live Support: https://app.cometchat.com
- UI Kit questions: https://www.cometchat.com/docs/ui-kit/react-native/5.0/getting-started
2 changes: 1 addition & 1 deletion chat-builder/react-router/integration.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "UI Kit Builder Integration"
sidebarTitle: "Integration"
description: "Step-by-step guide to integrating CometChat's UI Kit Builder into your React Router application, including initialization, user login, SSR handling, and rendering the CometChatApp component."
description: "Add CometChat UI Kit Builder to React Router apps with configurable chat features, themes, layouts, login, and SSR support."
---

The **UI Kit Builder** simplifies integrating CometChat's UI Kit into your React Router application — quickly set up chat, customize UI elements, and add features without extensive coding.
Expand Down
2 changes: 1 addition & 1 deletion chat-builder/react-router/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CometChat UI Kit Builder For React Router"
sidebarTitle: "Overview"
description: "CometChat UI Kit Builder for React Router is a visual development tool that helps you design and configure chat experiences for React Router applications without building the interface from scratch."
description: "CometChat UI Kit Builder for React Router is a low-code development tool to design and configure fully-featured chat experiences."
---

It provides a set of prebuilt, production-ready messaging components backed by CometChat's real-time infrastructure.
Expand Down
2 changes: 1 addition & 1 deletion chat-builder/react/integration.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "UI Kit Builder Integration"
sidebarTitle: "Integration"
description: "Step-by-step guide to integrating CometChat's UI Kit Builder into your React application, including initialization, user login, and rendering the CometChatApp component."
description: "Step-by-step guide to integrating CometChat UI Kit Builder into your React app with user login."
---

The **UI Kit Builder** simplifies integrating CometChat's UI Kit into your React application — quickly set up chat, customize UI elements, and add features without extensive coding.
Expand Down
2 changes: 1 addition & 1 deletion chat-builder/react/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CometChat UI Kit Builder For React"
sidebarTitle: "Overview"
description: "CometChat UI Kit Builder for React is a visual development tool that helps you design and configure chat experiences for React applications without building the interface from scratch."
description: "CometChat UI Kit Builder for React is a low-code development tool to design and configure fully-featured chat experiences."
---

It provides a set of prebuilt, production-ready messaging components backed by CometChat's real-time infrastructure.
Expand Down
2 changes: 1 addition & 1 deletion fundamentals/tenor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ GIFs are a great way to change the tone or convey emotions in your conversations

## Before you begin

1. Sign up at [Tenor](https://tenor.com/developer/dashboard) and create a new app.
1. Sign up at [Tenor](https://tenor.com/) and create a new app.
2. Enter your App name, description and click create.
3. Make note of the API key that has been created.

Expand Down
Binary file added images/automatic-web-socket-handling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manual-web-socket-connection-handling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion mcp-server.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "MCP Server"
description: "Model Context Protocol (MCP) server for CometChat documentation"
description: "Connect AI tools like Claude and Cursor to CometChat documentation with the MCP server to improve integration speed and developer productivity."
canonical: "https://www.cometchat.com/docs/mcp"
---

Expand Down
2 changes: 1 addition & 1 deletion moderation/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ route: "/getting-started"
description: "Getting Started — CometChat documentation."
---

# Moderation Integration
## Moderation Integration

To maintain a safe, respectful, and engaging environment for your users, our platform offers a powerful **Moderation Integration** system. This system allows you to automatically review, filter, and take action on user-generated messages, images, and videos before they are delivered.

Expand Down
2 changes: 1 addition & 1 deletion notifications/flutter-push-notifications-ios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Keep the provider IDs—you’ll set them in `CometChatConfig`.

## 3. Local configuration file

Update [`lib/cometchat_config.dart`](https://github.com/cometchat/cometchat-uikit-flutter/blob/v5/sample_app_push_notifications/lib/cometchat_config.dart) (or your own config file) so it exposes:
Update [`lib/app_credentials.dart`](https://github.com/cometchat/cometchat-uikit-flutter/blob/v5/sample_app_push_notifications/lib/app_credentials.dart) (or your own config file) so it exposes:

```dart lines
class CometChatConfig {
Expand Down
14 changes: 7 additions & 7 deletions notifications/react-native-push-notifications-ios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ For iOS we use Apple Push Notification service (APNs) for both standard and VoIP
<Step title="Create a certificate signing request (CSR)">
1. Open **Keychain Access** → Certificate Assistant → *Request a Certificate From a Certificate Authority*.<br/>
<Frame>
<img src="/images/cef182e1-1640937699-59eddd83a6c0783b06ccf5eebe3b7d94.png" />
<img alt="Apple Developer portal screenshot" src="/images/cef182e1-1640937699-59eddd83a6c0783b06ccf5eebe3b7d94.png" />
</Frame>
2. In **Certificate Information**, enter your Apple Developer email and a common name; choose **Saved to disk**, then **Continue**.
3. Save the CSR file locally—this contains your public/private key pair.
Expand All @@ -76,31 +76,31 @@ For iOS we use Apple Push Notification service (APNs) for both standard and VoIP
<Step title="Create the APNs SSL certificate (.cer)">
1. Sign in to the [Apple Developer Member Center](https://developer.apple.com/membercenter) → **Certificates, Identifiers & Profiles**.<br/>
<Frame>
<img src="/images/97122883-1640937720-fcd19d0ec4b22be8309cbad8172e611e.png" />
<img alt="Apple Developer portal screenshot" src="/images/97122883-1640937720-fcd19d0ec4b22be8309cbad8172e611e.png" />
</Frame>
2. Click **+** to add a certificate.<br/>
<Frame>
<img src="/images/0380f9ce-1640937733-db13c95c4dba1700cb3e9ad7016fb18c.png" />
<img alt="Apple Developer portal screenshot" src="/images/0380f9ce-1640937733-db13c95c4dba1700cb3e9ad7016fb18c.png" />
</Frame>
3. Under **Services**, pick **Apple Push Notification service SSL (Sandbox & Production)**.<br/>
<Frame>
<img src="/images/0b8820c9-1640937745-015a5fd67f1185d1b2d0272be3252a06.png" />
<img alt="Apple Developer portal screenshot" src="/images/0b8820c9-1640937745-015a5fd67f1185d1b2d0272be3252a06.png" />
</Frame>
4. Select your App ID, upload the CSR, continue, and download the generated `.cer` file.<br/>
<Frame>
<img src="/images/94bd7567-1640937759-985854eaa68734ab4ea0d63ac667fb1f.png" />
<img alt="Apple Developer portal screenshot" src="/images/94bd7567-1640937759-985854eaa68734ab4ea0d63ac667fb1f.png" />
</Frame>

&

<Frame>
<img src="/images/2465097e-1640937784-595c3a354a910eaf3e93a4c732160e96.png" />
<img alt="Apple Developer portal screenshot" src="/images/2465097e-1640937784-595c3a354a910eaf3e93a4c732160e96.png" />
</Frame>

&

<Frame>
<img src="/images/ce087489-1640937807-2c55cbabbfcbae49896063810822240d.png" />
<img alt="Apple Developer portal screenshot" src="/images/ce087489-1640937807-2c55cbabbfcbae49896063810822240d.png" />
</Frame>
</Step>

Expand Down
4 changes: 2 additions & 2 deletions sdk/android/connection-behaviour.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ On login, the SDK logs the user in, saves their details locally, and creates a W
The default mode. The SDK automatically establishes and maintains the WebSocket connection. Set `autoEstablishSocketConnection(true)` (or omit it — auto mode is the default).

<Frame>
<img src="/images/c8c546a3-x8a7yv541r6b9g8t73h9j3afh1p4cgsopv6yj238ebz8565rscv568a40zf34f5h-c617ae8f9a6f09edf27d37dd01ce1bf3.png" />
<img src="/images/automatic-web-socket-handling.png" alt="CometChat automatic WebSocket handling flow showing login, automatic connection, background disconnect, and auto reconnect on return to foreground" />
</Frame>

| App State | Behaviour |
Expand All @@ -59,7 +59,7 @@ Set `autoEstablishSocketConnection(false)` to take control of the WebSocket conn
By default in manual mode, the SDK disconnects after 30 seconds in the background if no pings are received. Call `CometChat.ping()` within 30 seconds to keep the connection alive.

<Frame>
<img src="/images/3207f2a4-6k068nprjmachrszi9ckyzgqxbf1rmc98asy5d09yhktx37v0pyxf6wxmufg2jci-4ab4b9056ff91b946fb2fc048bc764fa.png" />
<img src="/images/manual-web-socket-connection-handling.png" alt="CometChat manual WebSocket handling flow showing manual connect, 30-second background timeout, ping keep alive, optional disconnect, and reconnect flow" />
</Frame>

| App State | Behaviour |
Expand Down
2 changes: 1 addition & 1 deletion sdk/android/transient-messages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Transient Messages"
sidebarTitle: "Transient Messages"
description: "Send and receive ephemeral real-time messages that are not stored on the server using the CometChat Android SDK. Ideal for live reactions and temporary indicators."
description: "Send and receive ephemeral real-time messages with the CometChat Android SDK for live reactions and temporary indicators."
---

Transient messages are messages that are sent in real-time only and are not saved or tracked anywhere. The receiver of the message will only receive the message if he is online and these messages cannot be retrieved later.
Expand Down
4 changes: 2 additions & 2 deletions sdk/android/v5/connection-behaviour.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ CometChat SDK default connection behaviour is auto mode. Auto mode, the SDK auto
To enable auto mode, you need to set the autoEstablishSocketConnection() method of AppSettings builder class to true. If you do not set this, the SDK will automatically apply the auto mode as the default behaviour for the WebSocket connection.

<Frame>
<img src="/images/c8c546a3-x8a7yv541r6b9g8t73h9j3afh1p4cgsopv6yj238ebz8565rscv568a40zf34f5h-c617ae8f9a6f09edf27d37dd01ce1bf3.png" />
<img src="/images/automatic-web-socket-handling.png" alt="CometChat automatic WebSocket handling flow showing login, automatic connection, background disconnect, and auto reconnect on return to foreground" />
</Frame>

| App State | Behaviour |
Expand All @@ -48,7 +48,7 @@ To keep the WebSocket connection alive even if your app goes in the background,
If you do not call the `CometChat.ping()` method within 30 seconds, the SDK will disconnect the WebSocket connection. This means that you will lose any messages that are sent to your app while it is in the background.

<Frame>
<img src="/images/3207f2a4-6k068nprjmachrszi9ckyzgqxbf1rmc98asy5d09yhktx37v0pyxf6wxmufg2jci-4ab4b9056ff91b946fb2fc048bc764fa.png" />
<img src="/images/manual-web-socket-connection-handling.png" alt="CometChat manual WebSocket handling flow showing manual connect, 30-second background timeout, ping keep alive, optional disconnect, and reconnect flow" />
</Frame>

| App State | Behaviour |
Expand Down
1 change: 1 addition & 0 deletions sdk/android/v5/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Overview"
description: "Build Android chat apps with CometChat SDK v5, including real-time messaging, users, groups, and calling support."
---

<Warning>
Expand Down
2 changes: 1 addition & 1 deletion sdk/flutter/ai-agents.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "AI Agents"
sidebarTitle: "AI Agents"
description: "Learn how to integrate AI Agents in your Flutter app to enable intelligent, automated interactions that process user messages, trigger tools, and respond with contextually relevant information."
description: "Learn how to integrate AI Agents in your Flutter app to process messages, trigger tools, and respond with context."
---

<Accordion title="AI Integration Quick Reference">
Expand Down
4 changes: 2 additions & 2 deletions sdk/flutter/connection-behaviour.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ CometChat SDK default connection behaviour is auto mode. Auto mode, the SDK auto
To enable auto mode, you need to set the `autoEstablishSocketConnection()` method of AppSettings builder class to true. If you do not set this, the SDK will automatically apply the auto mode as the default behaviour for the WebSocket connection.

<Frame>
<img src="/images/c8c546a3-x8a7yv541r6b9g8t73h9j3afh1p4cgsopv6yj238ebz8565rscv568a40zf34f5h-c617ae8f9a6f09edf27d37dd01ce1bf3.png" />
<img src="/images/automatic-web-socket-handling.png" alt="CometChat automatic WebSocket handling flow showing login, automatic connection, background disconnect, and auto reconnect on return to foreground" />
</Frame>

| App State | Behaviour |
Expand All @@ -81,7 +81,7 @@ To keep the WebSocket connection alive even if your app goes in the background,
If you do not call the `CometChat.ping()` method within 30 seconds, the SDK will disconnect the WebSocket connection. This means that you will lose any messages that are sent to your app while it is in the background.

<Frame>
<img src="/images/3207f2a4-6k068nprjmachrszi9ckyzgqxbf1rmc98asy5d09yhktx37v0pyxf6wxmufg2jci-4ab4b9056ff91b946fb2fc048bc764fa.png" />
<img src="/images/manual-web-socket-connection-handling.png" alt="CometChat manual WebSocket handling flow showing manual connect, 30-second background timeout, ping keep alive, optional disconnect, and reconnect flow" />
</Frame>

| App State | Behaviour |
Expand Down
2 changes: 1 addition & 1 deletion sdk/flutter/message-structure-and-hierarchy.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Message Structure and Hierarchy"
sidebarTitle: "Message Structure"
description: "Understand the message categories, types, and class hierarchy in CometChat Flutter SDK including TextMessage, MediaMessage, CustomMessage, InteractiveMessage, and Action."
description: "Understand CometChat Flutter SDK message categories, types, class hierarchy, and text, media, custom, interactive, and action messages."
---

<Accordion title="AI Integration Quick Reference">
Expand Down
2 changes: 1 addition & 1 deletion sdk/flutter/transient-messages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Transient Messages"
sidebarTitle: "Transient Messages"
description: "Send and receive ephemeral real-time messages that are not stored on the server using the CometChat Flutter SDK. Ideal for live reactions and temporary indicators."
description: "Send and receive ephemeral real-time messages with the CometChat Flutter SDK for live reactions and temporary indicators."
---

<Accordion title="AI Integration Quick Reference">
Expand Down
Loading