Skip to content

docs(android)Add card streaming events and update documentation for card messages#406

Open
hritika-cometchat wants to merge 8 commits into
mainfrom
feature/android-uikit-card-agent
Open

docs(android)Add card streaming events and update documentation for card messages#406
hritika-cometchat wants to merge 8 commits into
mainfrom
feature/android-uikit-card-agent

Conversation

@hritika-cometchat

@hritika-cometchat hritika-cometchat commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Description

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

jitvarpatil
jitvarpatil previously approved these changes Jun 25, 2026
@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Jun 25, 2026, 11:27 AM

raj-dubey1
raj-dubey1 previously approved these changes Jun 25, 2026
raj-dubey1
raj-dubey1 previously approved these changes Jun 25, 2026
@hritika-cometchat hritika-cometchat changed the title Add card streaming events and update documentation for card messages docs(android)Add card streaming events and update documentation for card messages Jun 25, 2026
raj-dubey1
raj-dubey1 previously approved these changes Jun 25, 2026
@jitvarpatil

Copy link
Copy Markdown
Contributor

Docs review — ✅ Approve

Android SDK + UIKit v6 card-messages/streaming docs (11 files, +571/-306). It deletes interactive-messages.mdx but correctly adds a redirect for it, and the API surface checks out against the Android Chat SDK 5.0.4 and UIKit v6 source. Structurally clean.

✅ What passed (verified)

  • Deletion handled correctly: sdk/android/v5/interactive-messages.mdx is deleted, removed from nav, and a redirect was added → /sdk/android/v5/send-message (redirects +1; 0 unredirected removed URLs). 👍
  • Build / nav: 0 unresolved nav refs, 0 orphans. New campaigns.mdx is wired into nav (docs.json:4189); the new SVG is referenced in message-structure-and-hierarchy.mdx and is well-formed XML.
  • SDK card-streaming API (verified against chat-sdk-android 5.0.4):
    • addAIAssistantListener example uses the correct CometChat.AIAssistantListener() base class in both Java and Kotlin (no CometChat.CallListener mistake).
    • Card event classes (AIAssistantCardStartedEvent/ReceivedEvent/EndedEvent), getCardId(), getCard() all exist.
    • CardMessage accessors confirmed: getCard()JSONObject, getFallbackText()String, getTags()List<String>, getText()String; onCardMessageReceived(CardMessage) exists.
    • Kotlin examples use correct (name: Type) parameter syntax.
  • UIKit (verified against uikit-android v6 branch): setLoadLastAgentConversation/loadLastAgentConversation confirmed in both chatuikit-compose and chatuikit-kotlin CometChatMessageList — the migration row in message-list.mdx is accurate. CometChatUIEvent.CardActionClicked matches the file's sibling event-naming convention.
  • Content coherence: message-structure-and-hierarchy.mdx adds "card" as category maple-theme #3 with a ## Card section, the new diagram, and correct cross-links to send-message#card-message / receive-messages.
  • Broken links: the 2 the analyzer flagged (/sdk/android/calling-setup, /sdk/android/default-calling) are in unchanged files — pre-existing, out of scope.

🟡 P2 — one verification gap (author/SDK team to confirm)

The card-action class com.cometchat.cards.actions.CometChatCardActionEvent (cast target for event.actionEvent, with fields action/elementId/cardJson) lives in a separate com.cometchat.cards rendering module that isn't checked out in my workspace, so I couldn't confirm it from source. Its field names exactly match the verified Flutter CometChatCardActionEvent, so it's almost certainly correct — just worth confirming the exact class path and the CardActionClicked UI-event symbol against the shipped cards library.

Otherwise excellent work, and a good model for handling page deletions (redirect included).

🤖 Automated docs review (Mintlify link/redirect/content checks + API verification against cometchat chat-sdk-android 5.0.4 and uikit-android v6 source).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants