docs(ios-uikit): pin/save, pin conversations and thread subscription parity

[shreeyajoshi-cometchat]

1. Restructure, and remove an API that does not exist (f2312791)

Core features now match the other platforms: Pin Message and Save Message merge into one Pin & Save Messages section (iOS was the only platform splitting them), Pin Conversations is added, and Thread Subscription becomes a subsection of Threaded Conversations rather than a top-level section.

Every component-level enableThreadSubscription the docs described did not exist. It was removed from the message list, both headers, the pinned-messages page (invented wholesale there) and the guide, folding each described behaviour into the flag that does exist. hideThreadSubscriptionOption is likewise not a CometChatMessageList property — it lives on AdditionalConfiguration, and the sample now sets it there.

2. Document the opt-out (cd990e9a)

The feature ships on by default with no dashboard flag, so CometChatThreadSubscriptionConfig.setEnabled(false) is the only way to remove it — and nothing in the iOS docs said so. Adds a Turning the Feature Off section covering the call, how it ANDs with the per-instance hideThreadSubscription* flags (gate = whole app, hide flags = one screen), and that it can be flipped at any time rather than only before CometChatUIKit.init.

[mintlify]

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

Project	Status	Preview	Updated
cometchat	🟢 Ready	View Preview	Sep 15, 2026, 10:47 AM

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

[jitvarpatil]

Review: iOS UI Kit pin/save, pin conversations and thread subscription

Requesting changes. The restructure is good, and removing the component-level enableThreadSubscription properties is correct — none of them exist in the source. But parts of the new text describe thread subscription and pin conversations as they work on an unmerged UI Kit branch, not as they work in the published v5.1.22. Everything below was checked against release-v5-5.1.22 (identical to master-v5 for these files).

🔴 Blockers

1. "On by default" is wrong for 5.1.22

In 5.1.22 the feature is off unless the app opts in through UIKitSettings (UIKitSettings.swift:27, CometChatUIKit.swift:69):

var enableThreadSubscription = false
public func enable(threadSubscription: Bool) -> Self

The message-list option, the CometChatMessageHeader bell and the CometChatThreadedMessageHeader bell all check CometChatUIKit.isThreadSubscriptionEnabled() first. The sample app and master app both call .enable(threadSubscription: true).

"On by default" comes from feat/eng-37574-remove-threadsubscription-opt-in (uikit-ios PR #983), which is still open and based on ashfaq/eng-38638/merge-aditya, not dev-v5. A 5.1.22 customer following these docs will never see the bell or the action-sheet option, and no page tells them about enable(threadSubscription:).

Affected: core-features.mdx (enabledByDefault: true + "not gated" prose), guide-threaded-messages.mdx ("Both are shown by default"), message-header.mdx.

Fix, either: document the opt-in for now —

let uikitSettings = UIKitSettings()
    // ...
    .enable(threadSubscription: true)

— or hold this PR until #983 ships and add the version it lands in.

2. The hideThreadSubscriptionOption snippet does nothing (message-list.mdx)

The snippet sets the flag on CometChatMessageHeader.additionalConfiguration. The header only uses that configuration for its own auxiliary menu (CometChatMessageHeader.swift:288); the action-sheet option reads the message list's configuration (MessagesDataSource.swift:192 / :778). The list exposes it via getAdditionalConfiguration(), and AdditionalConfiguration is a class, so this works:

messageList.getAdditionalConfiguration().hideThreadSubscriptionOption = true

Also, guide-threaded-messages.mdx and core-features.mdx use messageListView.hideThreadSubscriptionOption = true — that property doesn't exist on CometChatMessageList, so it won't compile.

3. The pin-conversation gate is described wrong (conversations.mdx Warning)

The Warning says two gates are required: the app setting via CometChat.isPinConversationEnabled() and enablePinConversation. In 5.1.22 the app-setting check is removed (CometChatConversations.swift:614, marked TEMPORARY — REVERT BEFORE MERGE); only enablePinConversation && !hidePinConversationOption is checked. It's restored in 51a047c6c, which is on the same unmerged branch. Either scope the Warning to the release that restores the check, or say 5.1.22 only needs enablePinConversation.

🟠 Should fix

• Broken anchor /ui-kit/ios/message-header#thread-subscription — used twice in threaded-messages-header.mdx, both added in this PR. message-header.mdx has no such heading; the closest is #hidethreadsubscriptionbutton.
• Stale PR description — it describes a "Turning the Feature Off" section using CometChatThreadSubscriptionConfig.setEnabled(false). Neither is on the branch any more (later commits removed them), and that class doesn't exist in 5.1.22. Please update the description.

✅ Verified correct

• Deleted guide redirects to guide-threaded-messages#thread-subscription; the anchor exists and no iOS links to the old URL remain.
• enablePinConversation / hidePinConversationOption (Bool, default false), PinConversationErrorCodes, the "app_system" system-pin value, and the pinnedAt 0-sentinel note all match 5.1.22. Unpin does confirm first (PinSaveConfirmation.present(.unpinConversation…)).
• hideThreadSubscriptionButton exists on both headers (property + set(...)); the parent-message-only rule (parentMessageId == 0) is correct; the master app hides the reply-count-bar bell, matching the new navigation-bar guidance.
• The Pin & Save merge and the new Pin Conversations section match the other platforms.