Skip to content

docs(flutter): thread subscriptions, pin & save, composer trailing to… - #461

Open
anshuman-cometchat wants to merge 2 commits into
cometchat:mainfrom
anshuman-cometchat:feature/thread-pin-save
Open

docs(flutter): thread subscriptions, pin & save, composer trailing to…#461
anshuman-cometchat wants to merge 2 commits into
cometchat:mainfrom
anshuman-cometchat:feature/thread-pin-save

Conversation

@anshuman-cometchat

Copy link
Copy Markdown
Contributor

Description

Adds Flutter documentation for three newly shipped feature sets across the SDK (v5) and UI Kit (v6):

SDK (v5) — new pages, registered in the Messaging nav group:

  • Pin Messages (sdk/flutter/pin-messages) — pin/unpin APIs, permission model, real-time onMessagePinned/onMessageUnpinned events, fetching a conversation's pinned list via MessagesRequestBuilder, feature availability (isPinMessageEnabled()), limits and cap-error handling with errorParams.
  • Save Messages (sdk/flutter/save-messages) — private per-user bookmarks: save/unsave, own-device sync events, fetching saved messages, feature flag and limits.
  • Pin Conversations (sdk/flutter/pin-conversations) — pin/unpin, ConversationListener events, app_system (admin) pins, list-ordering contract, feature flag and limits.

SDK (v5) — extended:

  • Threaded Messages — new Thread Subscriptions section: subscribeToThread()/unsubscribeFromThread(), auto-subscribe semantics (reply / @-mention), cached state via getThreadSubscriptionState(), ThreadListener events, and fetching participated threads with ThreadsRequest.

UI Kit (v6) — extended:

  • Message Composer — new Trailing toolbar actions section documenting richTextToolbarActions and CometChatMessageComposerAction.onToolbarTap, including the web selection-blur caveat.
  • Conversations — new Pin Conversations section (long-press option, pinned-shelf ordering, live sync) and the pinConversationOptionVisibility property.
  • Message List — pin/save entries in the SDK-events and option-visibility tables, plus a Pin or save a message pattern.
  • Threaded Messages guide — new Thread Subscriptions section covering the UIKitSettings.enableThreadSubscription gate, the action-menu options, and the header notification bell.

All snippets follow the existing house conventions (<Tabs> Dart blocks, cascade builders, debugPrint callbacks) and API names were verified against the source of both packages.

Related Issue(s)

N/A — tracked internally (ENG-37600 / ENG-37601).

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

  • The three new SDK pages are registered in docs.json under SDKs → Flutter → Messaging (pin/save after Delete a Message, pin-conversations after Delete a Conversation).
  • These are the first docs for these features on any platform; other platforms can mirror this structure.
  • The conversation-pin cap error is described generically (no error code named) pending confirmation of the code the backend returns.
  • Verified locally with mint dev — all eight touched pages render.

Screenshots (if applicable)

N/A — text and code-snippet changes only.

…olbar actions

- New SDK v5 pages: Pin Messages, Save Messages, Pin Conversations
  (events, fetching, feature flags, limits and cap error handling)
- Thread Subscriptions section on the SDK Threaded Messages page
  (subscribe/unsubscribe, cached state, ThreadListener, ThreadsRequest)
- UI Kit v6: trailing toolbar actions on Message Composer
  (richTextToolbarActions + onToolbarTap), Pin Conversations section
  and option visibility on Conversations, pin/save options + events on
  Message List, thread-subscription gate and bell on the Threaded
  Messages guide
- Register the three new SDK pages in the Messaging nav group

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…esign

Subscription state now lives on the message (threadSubscribed boolean,
served on every fetch), the resolved subscribe/unsubscribe call is the
acknowledgement, and replies arrive on the standard MessageListener —
no ThreadListener, no getThreadSubscriptionState, no SDK-side events.
Documents the two consumer rules: an un-asked false means "the server
did not tell me", and a fetched false on the author's own message is an
explicit unsubscribe.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant