docs(android): thread subscription, pin & save messages, pin conversa…

docs.json

@@ -1839,6 +1839,8 @@
                               "ui-kit/android/call-buttons",
                               "ui-kit/android/call-logs",
                               "ui-kit/android/search",
+                              "ui-kit/android/pinned-messages",
+                              "ui-kit/android/saved-messages",
                               "ui-kit/android/ai-assistant-chat-history",
                               "ui-kit/android/notification-feed"
                             ]
@@ -1855,6 +1857,8 @@
                             "pages": [
                               "ui-kit/android/guide-overview",
                               "ui-kit/android/guide-threaded-messages",
+                              "ui-kit/android/guide-thread-subscription",
+                              "ui-kit/android/guide-pin-and-save-messages",
                               "ui-kit/android/guide-block-unblock-user",
                               "ui-kit/android/guide-new-chat",
                               "ui-kit/android/guide-message-privately",
@@ -4176,10 +4180,14 @@
                               "sdk/android/v5/additional-message-filtering",
                               "sdk/android/v5/retrieve-conversations",
                               "sdk/android/v5/threaded-messages",
+                              "sdk/android/v5/thread-subscription",
                               "sdk/android/v5/edit-message",
                               "sdk/android/v5/delete-message",
                               "sdk/android/v5/flag-message",
+                              "sdk/android/v5/pin-message",
+                              "sdk/android/v5/save-message",
                               "sdk/android/v5/delete-conversation",
+                              "sdk/android/v5/pin-conversation",
                               "sdk/android/v5/typing-indicators",
                               "sdk/android/v5/delivery-read-receipts",
                               "sdk/android/v5/transient-messages",

sdk/android/v5/additional-message-filtering.mdx

@@ -36,7 +36,7 @@
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .build();
@@ -60,7 +60,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setLimit(50)
   .setUID(UID)
   .build()
@@ -91,7 +91,7 @@
 <Tabs>
 <Tab title="Java">
 ```java
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
 .setUID("cometchat-uid-1")
 .setLimit(50)
 .build();
@@ -101,7 +101,7 @@
 
 <Tab title="Kotlin">
 ```kotlin
 val messagesRequest = MessagesRequestBuilder()
   .setUID("cometchat-uid-1")
   .setLimit(50)
   .build()
@@ -117,12 +117,12 @@
 
 You can achieve this using the `setGUID()` method. This method takes the GUID of a group for which the conversations are to be fetched. Passing a valid GUID to this method will return all the messages that are a part of the group conversation. Please note that the logged-in user must be a member of the group to fetch the messages for that group.
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder() .setGUID("cometchat-guid-1") .setLimit(50) .build();
 
 <Tabs>
 <Tab title="Java">
 ```java
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
 .setGUID("cometchat-guid-1")
 .setLimit(50)
 .build();
@@ -132,7 +132,7 @@
 
 <Tab title="Kotlin">
 ```kotlin
 val messagesRequest = MessagesRequestBuilder()
   .setGUID("cometchat-guid-1")
   .setLimit(50)
   .build()
@@ -153,7 +153,7 @@
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setMessageId(100)
   .setLimit(50)
   .setUID(UID)
@@ -179,7 +179,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setMessageId(100)
   .setLimit(50)
   .setUID(UID)
@@ -216,7 +216,7 @@
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setTimestamp(1512687363)
   .setLimit(50)
   .setUID(UID)
@@ -242,7 +242,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setTimestamp(1512687363)
   .setLimit(50)
   .setUID(UID)
@@ -279,7 +279,7 @@
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setUnread(true)
   .setLimit(50)
   .setUID(UID)
@@ -305,7 +305,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setUnread(true)
   .setLimit(50)
   .setUID(UID)
@@ -342,7 +342,7 @@
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .hideMessagesFromBlockedUsers(true)
   .setUID(UID)
   .setLimit(50)
@@ -368,7 +368,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .hideMessagesFromBlockedUsers(true)
   .setUID(UID)
   .setLimit(50)
@@ -405,7 +405,7 @@
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setUpdatedAfter(1514321321)
   .setLimit(50)
   .setUID(UID)
@@ -431,7 +431,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setUpdatedAfter(1514321321)
   .setLimit(50)
   .setUID(UID)
@@ -461,14 +461,14 @@
 
 *In other words, how do I fetch messages that have been updated after a particular date or time*
 
 This can be achieved easily by setting the updatesOnly parameter to true. To do so, you can use the updatesOnly() method. This method takes a boolean input and can be used with the `setUpdatedAfter()` method to get jus the updated messages and not the messages sent/received after the specified time. This method cannot be used independently and always needs to be used with the `setUpdatedAfter()` method.
 
 <Tabs>
 <Tab title="Java (User)">
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setUpdatedAfter(1514321321)
   .updatesOnly(true)
   .setLimit(50)
@@ -496,7 +496,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setUpdatedAfter(1514321321)
   .updatesOnly(true)
   .setLimit(50)
@@ -538,7 +538,7 @@
 categories.add("message");
 categories.add("custom");
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setCategories(categories)
   .setLimit(50)
   .setGUID(GUID)
@@ -570,7 +570,7 @@
 categories.add("message")
 categories.add("custom")
 
 val messagesRequest = MessagesRequestBuilder()
   .setCategories(categories)
   .setLimit(50)
   .setUID(UID)
@@ -619,7 +619,7 @@
 types.add("audio");
 types.add("file");
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setCategories(categories)
   .setTypes(types)
   .setLimit(50)
@@ -661,7 +661,7 @@
 types.add("audio")
 types.add("file")
 
 val messagesRequest = MessagesRequestBuilder()
   .setCategories(categories)
   .setTypes(types)
   .setLimit(50)
@@ -707,7 +707,7 @@
 ```java
 String UID = "cometchat-uid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setLimit(50)
   .setUID(UID)
   .setParentMessageId(100)
@@ -732,7 +732,7 @@
 <Tab title="Kotlin (User)">
 ```kotlin
 val UID = "cometchat-uid-1"
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .setParentMessageId(100)
@@ -745,7 +745,7 @@
 ```kotlin
 val GUID = "cometchat-guid-1"
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setGUID(GUID)
 .setParentMessageId(100)
@@ -782,7 +782,7 @@
 ```java
 String GUID = "cometchat-guid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setLimit(50)
   .hideReplies(true)
   .setGUID(GUID)
@@ -808,7 +808,7 @@
 ```kotlin
 val GUID = "cometchat-guid-1"
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .hideReplies(true)
 .setGUID(GUID)
@@ -843,7 +843,7 @@
 ```java
 String GUID = "cometchat-guid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setLimit(50)
   .setGUID(GUID)
   .hideDeletedMessages(true)
@@ -869,7 +869,7 @@
 ```kotlin
 val GUID = "cometchat-guid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setLimit(50)
   .setGUID(GUID)
   .hideDeletedMessages(true)
@@ -904,7 +904,7 @@
 ```java
 String GUID = "cometchat-guid-1";
 
 MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
   .setLimit(50)
   .setGUID(GUID)
   .hideQuotedMessages(true)
@@ -930,7 +930,7 @@
 ```kotlin
 val GUID = "cometchat-guid-1"
 
 val messagesRequest = MessagesRequestBuilder()
   .setLimit(50)
   .setGUID(GUID)
   .hideQuotedMessages(true)
@@ -969,7 +969,7 @@
 val tags: MutableList<String> = ArrayList()
 tags.add("pinned")
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .setTags(tags)
@@ -1004,7 +1004,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .withTags(true)
@@ -1045,7 +1045,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .hasLinks(true)
@@ -1086,7 +1086,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .hasAttachments(true)
@@ -1127,7 +1127,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .hasReactions(true)
@@ -1168,7 +1168,7 @@
 ```kotlin
 val UID = "cometchat-uid-1"
 
 val messagesRequest = MessagesRequestBuilder()
 .setLimit(50)
 .setUID(UID)
 .hasMentions(true)
@@ -1210,10 +1210,10 @@
 <Tab title="Kotlin">
 ```kotlin
 val UID = "cometchat-uid-1"
 val mentionedUIDs: MutableList<String> = ArrayList()
 mentionedUIDs.add("cometchat-uid-1")
 
 val messagesRequest = MessagesRequestBuilder()
   .setLimit(50)
   .setUID(UID)
   .setMentionedUIDs(mentionedUIDs)
@@ -1256,11 +1256,11 @@
 <Tab title="Kotlin">
 ```kotlin
 val UID = "cometchat-uid-1" 
   val attachmentTypes: MutableList<AttachmentType> = ArrayList()
   attachmentTypes.add(AttachmentType.FILE)
   attachmentTypes.add(AttachmentType.IMAGE)
 
   val messagesRequest = MessagesRequestBuilder()
     .setLimit(50)
     .setUID(UID)
     .setAttachmemnt(attachmentTypes)
@@ -1270,3 +1270,97 @@
 </Tab>
 
 </Tabs>
+
+## Pinned messages
+
+*In other words, how do I fetch the pinned messages of a conversation*
+
+This can be achieved by setting the pinned flag to true using the `setPinned()` method. Setting a `UID` or a `GUID` is mandatory for this filter — pinned messages are always scoped to a single conversation. The returned list is sorted by the time of pinning, most recently pinned first.
+
+<Tabs>
+<Tab title="Java (User)">
+```java
+String UID = "cometchat-uid-1";
+
+MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
+  .setPinned(true)
+  .setLimit(50)
+  .setUID(UID)
+  .build();
+```
+
+</Tab>
+
+<Tab title="Java (Group)">
+```java
+String GUID = "cometchat-guid-1";
+
+MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
+  .setPinned(true)
+  .setLimit(50)
+  .setGUID(GUID)
+  .build();
+```
+
+</Tab>
+
+<Tab title="Kotlin (User)">
+```kotlin
+val UID = "cometchat-uid-1"
+
+val messagesRequest = MessagesRequestBuilder()
+  .setPinned(true)
+  .setLimit(50)
+  .setUID(UID)
+  .build()
+```
+
+</Tab>
+
+<Tab title="Kotlin (Group)">
+```kotlin
+val GUID = "cometchat-guid-1"
+
+val messagesRequest = MessagesRequestBuilder()
+  .setPinned(true)
+  .setLimit(50)
+  .setGUID(GUID)
+  .build()
+```
+
+</Tab>
+
+</Tabs>
+
+For the full pin workflow — pinning, unpinning, limits and real-time events — see [Pin A Message](/sdk/android/v5/pin-message).
+
+## Saved messages
+
+*In other words, how do I fetch the messages the logged-in user has saved*
+
+This can be achieved by setting the saved flag to true using the `setSaved()` method. Saved messages are private to the logged-in user and span all of their conversations, so this filter must **not** be combined with `setUID()` or `setGUID()`. The returned list is sorted by the time of saving, most recently saved first.
+
+<Tabs>
+<Tab title="Java">
+```java
+MessagesRequest messagesRequest = new MessagesRequest.MessagesRequestBuilder()
+  .setSaved(true)
+  .setLimit(50)
+  .build();
+```
+
+</Tab>
+
+<Tab title="Kotlin">
+```kotlin
+val messagesRequest = MessagesRequestBuilder()
+  .setSaved(true)
+  .setLimit(50)
+  .build()
+```
+
+</Tab>
+
+</Tabs>
+
+For the full save workflow — saving, unsaving, limits and real-time events — see [Save A Message](/sdk/android/v5/save-message).