Skip to content

feat(pin-save-thread-subscription-js-sdk): add documentation for pin/save messages, pin conversations and thread subscription - #469

Open
PrajwalDhuleCC wants to merge 1 commit into
mainfrom
feature/pin-save-thread-subscription-js-sdk
Open

feat(pin-save-thread-subscription-js-sdk): add documentation for pin/save messages, pin conversations and thread subscription#469
PrajwalDhuleCC wants to merge 1 commit into
mainfrom
feature/pin-save-thread-subscription-js-sdk

Conversation

@PrajwalDhuleCC

Copy link
Copy Markdown
Contributor

Description

Add documentation for pin/save messages, pin conversations and thread subscription

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)

…save messages, pin conversations and thread subscription
@mintlify

mintlify Bot commented Aug 16, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Aug 16, 2026, 6:24 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@raj-dubey1

Copy link
Copy Markdown
Contributor

Docs review — ⚠️ Request changes (hold until the APIs ship)

Thanks for this! Reviewed the branch end-to-end (structural checks + verified every documented symbol against the published SDK). Structurally the PR is clean and build-safe — but the core feature pages document SDK methods that don't exist in any published version of @cometchat/chat-sdk-javascript, so if this merges to main today every code example on those pages throws for readers.

✅ What passed

  • Build-safe: 0 dangling nav refs, 0 orphaned pages, 0 missing redirects (additive PR, so no 404 risk).
  • Genuinely correct pages: threaded-messages.mdx, the base of message-filtering.mdx, and the base of all-real-time-listeners.mdx match the shipped SDK (setParentMessageId, withParent, hideReplies, the real listeners/callbacks, AttachmentType, etc. all verified present).

🔴 Blocker — documented APIs don't exist in any published SDK

Verified against @cometchat/chat-sdk-javascript@4.1.13 (the only dist-tag is latest; there is no beta/next/rc). Checked both the type definitions (CometChat.d.ts) and the runtime bundle (CometChat.js) — grep returns zero matches for all of the following (while known-real methods like sendMessage match fine, so the grep is sound):

Page Symbols that do not exist in 4.1.13
pin-message.mdx CometChat.pinMessage / unpinMessage, MessagesRequestBuilder.setPinned, BaseMessage.isPinned/getPinnedAt/getPinnedBy/isSystemPinned, getPinnedMessagesLimit, getSystemPinnedMessagesLimit, isPinMessageEnabled, MessageListener.onMessagePinned/onMessageUnpinned
save-message.mdx CometChat.saveMessage / unsaveMessage, MessagesRequestBuilder.setSaved, BaseMessage.isSaved/getSavedAt, getSavedMessagesLimit, isSaveMessageEnabled, onMessageSaved/onMessageUnsaved
pin-conversation.mdx CometChat.pinConversation / unpinConversation, ConversationsRequestBuilder.setPinnedBy, CometChat.PINNED_BY, Conversation.isPinned/getPinnedAt/getPinnedBy, getPinnedConversationsLimit, isPinConversationEnabled, and the whole ConversationListener / addConversationListener API
thread-subscription.mdx CometChat.subscribeToThread / unsubscribeFromThread, BaseMessage.isThreadSubscribed/setThreadSubscribed, the ThreadsRequest / ThreadsRequestBuilder classes, and the MessageThread model (getReplyCount() is real but lives on BaseMessage, not MessageThread)

Two otherwise-correct pages also have non-existent symbols grafted in:

  • message-filtering.mdx — the "Pinned messages" / "Saved messages" sections use setPinned(true) / setSaved(true) (don't exist on the builder).
  • all-real-time-listeners.mdx — adds a Conversation Listener section (ConversationListener class doesn't exist) and injects onMessagePinned/onMessageUnpinned/onMessageSaved/onMessageUnsaved into the real MessageListener table (these callbacks never fire — worse than a hard error since it looks like it works).

Error constants ERR_ACTION_NOT_ALLOWED and INVALID_PARENT_MESSAGE_ID also don't appear anywhere in the SDK.

Ask

If these document an upcoming SDK release: please hold/gate this PR until that version is published, pin the install/examples to it, and re-verify the exact method names + signatures against the shipped build before publishing (an unreleased build may differ from the draft). If the release is already staged, linking the SDK version/PR here would let us confirm quickly. If any of these are simply the wrong name for an existing API, happy to help map them.

Note (pre-existing, not caused by this PR)

The link scan flagged direct-call, default-call, standalone-calling, and interactive-messages as broken targets — but they also appear in files this PR doesn't touch (message-structure-and-hierarchy.mdx, send-message.mdx), so they're pre-existing and out of scope here.

🤖 Automated docs-PR review (structural script + API verification against the published package). Flagging for a human to confirm the release timing.

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

Labels

2 participants