Skip to content

docs(ui-kit/ios,sdk/ios): pin & save messages and thread subscription - #465

Open
shreeyajoshi-cometchat wants to merge 1 commit into
mainfrom
docs/ios-thread-subscription-pin-save
Open

docs(ui-kit/ios,sdk/ios): pin & save messages and thread subscription#465
shreeyajoshi-cometchat wants to merge 1 commit into
mainfrom
docs/ios-thread-subscription-pin-save

Conversation

@shreeyajoshi-cometchat

@shreeyajoshi-cometchat shreeyajoshi-cometchat commented Aug 10, 2026

Copy link
Copy Markdown

Description

Docs: Pin & Save Messages and Thread Subscription for iOS

Documents the two iOS v5 features that shipped in 5.1.19 with no documentation — Pin & Save Messages (ENG-37851..37853) and Thread Subscription (ENG-37571..37575).

New pages

  • sdk/ios/pin-save-message — pin/unpin, save/unsave, list fetch via MessagesRequest + set(pinned:)/set(saved:), and the real-time delegate callbacks.
  • sdk/ios/thread-subscriptionsubscribeToThread/unsubscribeFromThread, the tri-state threadSubscriptionState, ThreadsRequest and the MessageThread model, and the two CometChatThreadDelegate callbacks.
  • ui-kit/ios/pinned-messagesCometChatPinnedMessages (per-conversation, opened from the message header).
  • ui-kit/ios/saved-messagesCometChatSavedMessages (personal, cross-conversation).
  • ui-kit/ios/guide-pin-save-message — end-to-end walkthrough.
  • ui-kit/ios/guide-thread-subscription — the gate, the action-sheet option, the message-header bell, and cross-surface sync.

Updated pages

  • message-listenablePinMessage, enableSaveMessage, enableThreadSubscription, and the matching hide*Option flags.
  • message-headerparentMessage, enableThreadSubscription, hideThreadSubscriptionButton (the subscription bell).
  • eventsccMessagePinned / ccMessageSaved, plus a Thread Events section for ccThreadSubscriptionChanged.
  • message-template — the new option ids.
  • core-features, components-overview, guide-overview, guide-threaded-messages, sdk/ios/threaded-messages — feature entries and cross-links.
  • docs.json — registered the new pages.

Two SDK pages used "pinned" as a tags example, which now reads as the pin feature; changed to "important" with a pointer to the real API.

Notes for review

  • Thread-subscription copy is "Subscribe to thread" / "Unsubscribe from thread", carried by the THREAD_SUBSCRIBE / THREAD_UNSUBSCRIBE keys.
  • The subscription option is offered on parent messages only, never on a reply, and is not gated on reply count. This differs from Android, which shows the option on replies too and re-roots the subscription to the thread's parent — worth a product call on whether iOS should match.
  • Unlike React, iOS has no receiver-type check, so the option appears in one-on-one conversations as well as groups. The pages describe iOS's actual behaviour rather than calling the feature group-only — Android and Flutter also allow 1:1.

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

Depends on cometchat-team/uikit-ios#935[iOS] Thread Subscription — finalised copy + header subscribe control (ENG-37575), which carries the renamed THREAD_* string keys and the CometChatMessageHeader subscription bell that these pages document. This PR should merge after #935 lands.

Screenshots (if applicable)

@mintlify

mintlify Bot commented Aug 10, 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 10, 2026, 8:17 AM

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

Documents the two iOS features from the 5.1.19 release that had no
documentation: Pin & Save Messages (ENG-37851..37853) and Thread
Subscription (ENG-37571..37575).

New pages:
- sdk/ios/pin-save-message - pin/unpin, save/unsave, list fetch via
  MessagesRequest, and the real-time delegate callbacks
- ui-kit/ios/pinned-messages - the per-conversation pinned panel
- ui-kit/ios/saved-messages - the private cross-conversation panel
- ui-kit/ios/guide-pin-save-message - end-to-end guide
- sdk/ios/thread-subscription - subscribeToThread/unsubscribeFromThread,
  the tri-state threadSubscriptionState, ThreadsRequest and the
  MessageThread model, and the CometChatThreadDelegate callbacks
- ui-kit/ios/guide-thread-subscription - the gate, the action-sheet
  option, the message-header bell, and cross-surface sync

Updated where the features landed: message-list, message-header,
message-template, events, core-features, conversations,
components-overview, guide-overview, guide-threaded-messages,
sdk/ios/threaded-messages and docs.json navigation.

Thread-subscription notes:
- copy is "Subscribe to thread"/"Unsubscribe from thread", carried by
  the THREAD_SUBSCRIBE/THREAD_UNSUBSCRIBE keys
- the bell ships in CometChatMessageHeader, gated by parentMessage plus
  enableThreadSubscription, with hideThreadSubscriptionButton as the
  escape hatch for a host that draws its own
- the action-sheet option is offered on parent messages only, never on
  a reply, but is not gated on reply count
- unlike React, iOS has no receiver-type check, so the option appears in
  one-on-one conversations as well as groups; the pages say so rather
  than describing the feature as group-only

Two SDK pages used "pinned" as a tags example, which now reads as the
pin feature; changed to "important" with a pointer to the real API.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.

1 participant