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

docs.json

@@ -1496,6 +1496,8 @@
                               "ui-kit/ios/message-composer",
                               "ui-kit/ios/compact-message-composer",
                               "ui-kit/ios/threaded-messages-header",
+                              "ui-kit/ios/pinned-messages",
+                              "ui-kit/ios/saved-messages",
                               "ui-kit/ios/incoming-call",
                               "ui-kit/ios/outgoing-call",
                               "ui-kit/ios/ongoing-call",
@@ -1526,6 +1528,8 @@
                             "pages": [
                               "ui-kit/ios/guide-overview",
                               "ui-kit/ios/guide-threaded-messages",
+                              "ui-kit/ios/guide-thread-subscription",
+                              "ui-kit/ios/guide-pin-save-message",
                               "ui-kit/ios/guide-block-unblock-user",
                               "ui-kit/ios/guide-new-chat",
                               "ui-kit/ios/guide-message-privately",
@@ -3846,6 +3850,7 @@
                               "sdk/ios/additional-message-filtering",
                               "sdk/ios/retrieve-conversations",
                               "sdk/ios/threaded-messages",
+                              "sdk/ios/thread-subscription",
                               "sdk/ios/edit-message",
                               "sdk/ios/delete-message",
                               "sdk/ios/delete-conversation",
@@ -3854,7 +3859,8 @@
                               "sdk/ios/transient-messages",
                               "sdk/ios/delivery-read-receipts",
                               "sdk/ios/mentions",
-                              "sdk/ios/reactions"
+                              "sdk/ios/reactions",
+                              "sdk/ios/pin-save-message"
                             ]
                           },
                           "sdk/ios/calling-overview",

sdk/ios/additional-message-filtering.mdx

@@ -146,13 +146,17 @@ Use `setTags()` with an array of tag names to fetch only messages with those tag
 
 ```swift
 var limit = 30
-let tags = ["pinned"]
+let tags = ["important"]
 let messagesRequest = MessagesRequest.MessageRequestBuilder()
   .setLimit(50)
   .setTags(tags)
   .build()
 ```
 
+<Note>
+To fetch pinned or saved messages, filter with `set(pinned:)` or `set(saved:)` rather than tags — see [Pin & Save Messages](/sdk/ios/pin-save-message).
+</Note>
+
 ---
 
 ## Next Steps

sdk/ios/all-real-time-delegates-listeners.mdx

@@ -95,13 +95,13 @@
 
 | Method                                                                                                                                            | Information                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
 | **onGroupMemberJoined(action:** [`Action`](/sdk/reference/messages#action)**, joinedUser:** [`User`](/sdk/reference/entities#user)**, joinedGroup:** [`Group`](/sdk/reference/entities#group)**)**                                                                     | This method is triggered when a user joins any group. All the members present in the group will receive this event.                            |
 | **onGroupMemberLeft(action:** [`Action`](/sdk/reference/messages#action)**, leftUser:** [`User`](/sdk/reference/entities#user)**, leftGroup:** [`Group`](/sdk/reference/entities#group)**)**                                                                           | This method is triggered when a user who was a member of any group leaves the group. All the members of the group receive this event.          |
 | **onGroupMemberKicked(action:** [`Action`](/sdk/reference/messages#action)**, kickedUser:** [`User`](/sdk/reference/entities#user)**, kickedBy:** [`User`](/sdk/reference/entities#user)**, kickedFrom:** [`Group`](/sdk/reference/entities#group)**)**                                                      | This method is triggered when a user is kicked from a group. All the members including the user receive this event                             |
 | **onGroupMemberBanned(action:** [`Action`](/sdk/reference/messages#action)**, bannedUser:** [`User`](/sdk/reference/entities#user)**, bannedBy:** [`User`](/sdk/reference/entities#user)**, bannedFrom:** [`Group`](/sdk/reference/entities#group)**)**                                                      | This method is triggered when a user is banned from a group. All the members including the user receive this event                             |
 | **onGroupMemberUnbanned(action:** [`Action`](/sdk/reference/messages#action)**, unbannedUser:** [`User`](/sdk/reference/entities#user)**, unbannedBy:** [`User`](/sdk/reference/entities#user)**, unbannedFrom:** [`Group`](/sdk/reference/entities#group)**)**                                              | This method is triggered when a user is banned from a group. All the members of the group receive this event.                                  |
 | **onGroupMemberScopeChanged(action:** [`Action`](/sdk/reference/messages#action)**, updatedBy:** [`User`](/sdk/reference/entities#user)**, updatedUser:** [`User`](/sdk/reference/entities#user)**, scopeChangedTo: String, scopeChangedFrom: String, group:** [`Group`](/sdk/reference/entities#group)**)** | This method is triggered when the scope of any Group Member has been changed. All the members that are a part of that group receive this event |
 | **onMemberAddedToGroup(action:** [`Action`](/sdk/reference/messages#action)**, addedby:** [`User`](/sdk/reference/entities#user)**, userAdded:** [`User`](/sdk/reference/entities#user)**, addedTo:** [`Group`](/sdk/reference/entities#group)**)**                                                          | This method is triggered when a user is added to any group. All the members including the user himself receive this event.                     |
 
 You can receive live events related to groups. In order to receive group events, you must add protocol conformance `CometChatGroupDelegate` as shown below:
 
@@ -114,23 +114,23 @@
     print("\\(joinedUser.name) joined the group \\(joinedGroup.name).")
   }
 
   func onGroupMemberLeft(action: ActionMessage, leftUser: User, leftGroup: Group) {
     print("\\(leftUser.name) left the group \\(leftGroup.name).")
   }
 
   func onGroupMemberKicked(action: ActionMessage, kickedUser: User, kickedBy: User, kickedFrom: Group) {
     print("\\(kickedUser.name) kicked from the group \\(kickedFrom.name) by \\(kickedBy.name).")
   }
 
   func onGroupMemberBanned(action: ActionMessage, bannedUser: User, bannedBy: User, bannedFrom: Group) {
     print("\\(bannedUser.name) banned from the group \\(bannedFrom.name) by \\(bannedBy.name).")
   }
 
   func onGroupMemberUnbanned(action: ActionMessage, unbannedUser: User, unbannedBy: User, unbannedFrom: Group) {
     print("\\(unbannedUser.name) unbanned from the group \\(unbannedFrom.name) by \\(unbannedBy.name).")
   }
 
   func onGroupMemberScopeChanged(action: ActionMessage, scopeChangeduser: User, scopeChangedBy: User, scopeChangedTo: String, scopeChangedFrom: String, group: Group) {
     print("\\(scopeChangedUser.name) scope changed from \\(scopeChangedFrom) to \\(scopeChangedTo) by \\(scopeChangedBy.name) in the group \\(group.name).")
   }
 }
@@ -199,8 +199,8 @@
 | **onTextMessageReceived(textMessage:** [`TextMessage`](/sdk/reference/messages#textmessage)**)** | This event is triggered when a Text Message is received.                                                |
 | **onMediaMessageReceived(mediaMessage:** [`MediaMessage`](/sdk/reference/messages#mediamessage)**)** | This event is triggered when a Media Message is received.                                               |
 | **onCustomMessageReceived(customMessage:** [`CustomMessage`](/sdk/reference/messages#custommessage)**)** | This event is triggered when a Custom Message is received.                                              |
 | **onTypingStarted(_ typingDetails:** [`TypingIndicator`](/sdk/reference/auxiliary#typingindicator)**)** | This event is triggered when a user starts typing in a user/group conversation.                         |
 | **onTypingEnded(_ typingDetails:** [`TypingIndicator`](/sdk/reference/auxiliary#typingindicator)**)** | This event is triggered when a user stops typing in a user/group conversation.                          |
 | **onTransisentMessageReceived(_ message:** [`TransientMessage`](/sdk/reference/auxiliary#transientmessage)**)** | This event is triggered when a transient message is received.                                           |
 | **onMessagesDelivered(receipt:** [`MessageReceipt`](/sdk/reference/auxiliary#messagereceipt)**)** | This event is triggered when a set of messages are marked as delivered for any particular conversation. |
 | **onMessagesRead(receipt:** [`MessageReceipt`](/sdk/reference/auxiliary#messagereceipt)**)** | This event is triggered when a set of messages are marked as read for any particular conversation.      |
@@ -212,6 +212,10 @@
 | **onInteractionGoalCompleted(_ receipt: InteractionReceipt)**| This event is triggered when an interaction Goal is achieved.                                           |
 | **onMessageReactionAdded(reactionEvent: ReactionEvent)**     | This event is triggered when a reaction is added to a message.                                          |
 | **onMessageReactionRemoved(reactionEvent: ReactionEvent)**   | This event is triggered when a reaction is removed from a message.                                      |
+| **onMessagePinned(message:** [`BaseMessage`](/sdk/reference/messages#basemessage)**)** | *Available since v4.1.9.* This event is triggered when a message is pinned. Broadcast to everyone in the conversation. See [Pin & Save Messages](/sdk/ios/pin-save-message). |
+| **onMessageUnpinned(message:** [`BaseMessage`](/sdk/reference/messages#basemessage)**)** | *Available since v4.1.9.* This event is triggered when a message is unpinned. Broadcast to everyone in the conversation. |
+| **onMessageSaved(message:** [`BaseMessage`](/sdk/reference/messages#basemessage)**)** | *Available since v4.1.9.* This event is triggered when a message is saved. Private — reaches only the saving user's other devices. |
+| **onMessageUnsaved(message:** [`BaseMessage`](/sdk/reference/messages#basemessage)**)** | *Available since v4.1.9.* This event is triggered when a message is unsaved. Private — reaches only the saving user's other devices. |
 | **onMessageModerated(_ message:** [`BaseMessage`](/sdk/reference/messages#basemessage)**)** | This event is triggered when a message is moderated.                                                    |
 | **onAIAssistantMessageReceived(_ message: AIAssistantMessage)** | This event is triggered when an AI Assistant message is received.                                    |
 | **onAIToolResultMessageReceived(_ message: AIToolResultMessage)** | This event is triggered when an AI Tool result message is received.                                |
@@ -244,11 +248,11 @@
     print("Message deleted successfully.")
   }
 
   func onTypingStarted(_ typingDetails: TypingIndicator) {
     print("Typing started received successfully")
   }
 
   func onTypingEnded(_ typingDetails: TypingIndicator) {
     print("Typing ended received successfully")
   }
 

sdk/ios/edit-message.mdx

@@ -49,9 +49,11 @@ The `edit()` method returns a [`BaseMessage`](/sdk/reference/messages#basemessag
 
 Use `tags` to update tags when editing. New tags replace existing ones.
 
+Tags are your own free-form labels and are unrelated to pinning a message — to pin one, use [Pin & Save Messages](/sdk/ios/pin-save-message).
+
 ```swift
-let tags = ["pinned", "important"]
-let textMessage = TextMessage(receiverUid: "cometchat-uid-2", text: "Pinned message", receiverType: .user)
+let tags = ["important", "follow-up"]
+let textMessage = TextMessage(receiverUid: "cometchat-uid-2", text: "Tagged message", receiverType: .user)
 textMessage.id = 12345
 textMessage.tags = tags