@cometchat/chat-sdk-javascript 4.0.11 → 4.0.13

package/CometChat.d.ts

@@ -7,9 +7,9 @@
   * @param {string} appId appId generted at the time of perchase. unique for each client.
   * @returns {CometChat}
   */
-export function init(appId: string): CometChat;
-export as namespace CometChat;
-export as namespace CometChatNotifications;
+  export function init(appId: string): CometChat;
+  export as namespace CometChat;
+  export as namespace CometChatNotifications;
 
 export class CometChat {
         static GroupType: typeof GroupType;
@@ -392,6 +392,12 @@ export class CometChat {
                                 MENTIONS_WITH_TAG_INFO: string;
                                 MENTIONS_WITH_BLOCKED_INFO: string;
                                 ONLY_INTERACTION_GOAL_COMPLETED: string;
+                                HAS_ATTACHMENTS: string;
+                                HAS_LINKS: string;
+                                HAS_MENTIONS: string;
+                                HAS_REACTIONS: string;
+                                MENTIONED_UIDS: string;
+                                ATTACHMENT_TYPES: string;
                         };
                 };
         };
@@ -975,6 +981,7 @@ export class CometChat {
                 MSG_VER_POST: string;
         };
         static GoalType: typeof GoalType;
+        static AttachmentType: typeof AttachmentType;
         static CometChatException: typeof CometChatException;
         static TextMessage: typeof TextMessage;
         static MediaMessage: typeof MediaMessage;
@@ -988,6 +995,7 @@ export class CometChat {
         static InteractionGoal: typeof InteractionGoal;
         static Interaction: typeof Interaction;
         static InteractionReceipt: typeof InteractionReceipt;
+        static MessageReceipt: typeof MessageReceipt;
         static Group: typeof Group;
         static User: typeof User;
         static GroupMember: typeof GroupMember;
@@ -1111,7 +1119,6 @@ export class CometChat {
                 PROTECTED: string;
                 PASSWORD: string;
         };
-        static MessageReceipt: typeof MessageReceipt;
         /**
             * Setter method for CometChat authToken.
             * @internal
@@ -3042,6 +3049,12 @@ export const MessageConstatnts: {
             MENTIONS_WITH_TAG_INFO: string;
             MENTIONS_WITH_BLOCKED_INFO: string;
             ONLY_INTERACTION_GOAL_COMPLETED: string;
+            HAS_ATTACHMENTS: string;
+            HAS_LINKS: string;
+            HAS_MENTIONS: string;
+            HAS_REACTIONS: string;
+            MENTIONED_UIDS: string;
+            ATTACHMENT_TYPES: string;
         };
     };
 };
@@ -3837,6 +3850,12 @@ export const AI_FEATURE_ACCESSIBLE = "features.ai.accessible";
 export const AI_FEATURE_ENABLED = "features.ai.enabled";
 export const AI_SLUG_ACCESSIBLE = "features.ai.%s.accessible";
 export const AI_SLUG_ENABLED = "features.ai.%s.enabled";
+export enum AttachmentType {
+    IMAGE = "image",
+    VIDEO = "video",
+    AUDIO = "audio",
+    FILE = "file"
+}
 
 /**
     *
@@ -5243,6 +5262,11 @@ export class ConversationsRequest {
             * @returns {string}
          */
         getConversationType(): string;
+        /**
+            * Method to get the search string based on which the conversations will be fetched.
+            * @returns {string}
+         */
+        getSearchKeyword(): string;
         /**
             * Checks if the filtering should include both user and group tags.
             * @return true if both user and group tags are included. false otherwise.
@@ -5273,6 +5297,12 @@ export class ConversationsRequest {
             * @returns {String[]}
          */
         getUserTags(): String[];
+        /**
+            * Determines whether only unread conversations should be fetched.
+            *
+            * @returns {boolean}
+         */
+        getUnread(): boolean;
 }
 export class ConversationsRequestBuilder {
         /** @private */ conversationType: string;
@@ -5284,6 +5314,8 @@ export class ConversationsRequestBuilder {
         /** @private */ userTags: Array<String>;
         /** @private */ IncludeBlockedUsers: boolean;
         /** @private */ WithBlockedInfo: boolean;
+        /** @private */ searchKeyword: string;
+        /** @private */ unreadOnly: boolean;
         /**
             *
             * @param {number} limit
@@ -5298,6 +5330,14 @@ export class ConversationsRequestBuilder {
             * @returns
          */
         setConversationType(conversationType: string): this;
+        /**
+            *
+            * @param {string} searchKeyword
+            * Method to set the search string based on which the conversations will be fetched.
+            * This string will be searched in the `conversationWith` property.
+            * @returns
+         */
+        setSearchKeyword(searchKeyword: string): this;
         /**
             *
             * @param {boolean} getUserAndGroupTags
@@ -5358,6 +5398,12 @@ export class ConversationsRequestBuilder {
             * @returns
          */
         withBlockedInfo(_withBlockedInfo: boolean): this;
+        /**
+            * A method to fetch unread conversations.
+            * @param {boolean} unread
+            * @returns
+         */
+        setUnread(unread: boolean): this;
         /**
             * This method will return an object of the ConversationsRequest class.
             * @returns {ConversationsRequest}
@@ -5471,6 +5517,36 @@ export class MessagesRequest {
             * @return {boolean}
             */
         isHideDeletedMessages(): boolean;
+        /**
+            * Gets the flag indicating whether to only fetch messages which have attachments.
+            *
+            * @return {boolean}
+            */
+        getHasAttachments(): boolean;
+        /**
+            * Method to only fetch messages which have links.
+            *
+            * @return {boolean}
+            */
+        getHasLinks(): boolean;
+        /**
+         * Method to only fetch messages which have mentions.
+         *
+         * @return {boolean}
+         */
+        getHasMentions(): boolean;
+        /**
+         * Method to only fetch messages which have reactions.
+         *
+         * @return {boolean}
+         */
+        getHasReactions(): boolean;
+        /**
+         * Method to only fetch messages which have the given mentioned UIDs.
+         *
+         * @return {String[]}
+         */
+        getMentionedUIDs(): String[];
         /**
             * Gets the list of tags for which the messages are to be fetched.
             *
@@ -5501,6 +5577,11 @@ export class MessagesRequest {
             * @return {boolean}
             */
         isInteractionGoalCompletedOnly(): boolean;
+        /**
+            * Returns the list of selected attachment types used for filtering messages.
+            * @return {Array<AttachmentTypes>}
+         */
+        getAttachmentTypes(): Array<AttachmentType>;
         /**
             * Get list of next messages based on the parameters specified in MessagesRequestBuilder class. The Developer need to call this method repeatedly using the same object of MessagesRequest class to get paginated list of message.
             * @returns {Promise<BaseMessage[] | []>}
@@ -5536,6 +5617,12 @@ export class MessagesRequestBuilder {
         /** @private */ interactionGoalCompletedOnly?: boolean;
         /** @private */ mentionsWithUserTags?: boolean;
         /** @private */ mentionsWithBlockedRelation?: boolean;
+        /** @private */ HasAttachments?: boolean;
+        /** @private */ HasLinks?: boolean;
+        /** @private */ HasMentions?: boolean;
+        /** @private */ HasReactions?: boolean;
+        /** @private */ mentionedUIDs?: Array<String>;
+        /** @private */ attachmentTypes?: Array<AttachmentType>;
         /**
             * A method to set limit for the number of messages returned in a single iteration. A maximum of 100 messages can fetched in a single iteration.
             * @param {number} limit
@@ -5638,6 +5725,36 @@ export class MessagesRequestBuilder {
             * @returns
          */
         hideDeletedMessages(hideDeletedMessages: boolean): this;
+        /**
+            * Method to only fetch messages which have attachments.
+            * @param {boolean} hasAttachments
+            * @returns
+         */
+        hasAttachments(hasAttachments: boolean): this;
+        /**
+            * Method to only fetch messages which have links.
+            * @param {boolean} hasLinks
+            * @returns
+         */
+        hasLinks(hasLinks: boolean): this;
+        /**
+            * Method to only fetch messages which have mentions.
+            * @param {boolean} hasMentions
+            * @returns
+         */
+        hasMentions(hasMentions: boolean): this;
+        /**
+            * Method to only fetch messages which have reactions.
+            * @param {boolean} hasReactions
+            * @returns
+         */
+        hasReactions(hasReactions: boolean): this;
+        /**
+            * Method to only fetch messages which have the given mentioned UIDs.
+            * @param {Array<String>} mentionedUIDs
+            * @returns
+         */
+        setMentionedUIDs(mentionedUIDs: Array<String>): this;
         /**
             * A method to set parameter to get the messages belonging to specific tags.
             * @param {Array<String>} tags
@@ -5668,6 +5785,12 @@ export class MessagesRequestBuilder {
             * @returns
          */
         setInteractionGoalCompletedOnly(interactionGoalCompletedOnly?: boolean): this;
+        /**
+            * Filters messages by specific attachment types.
+            * @param {Array<AttachmentTyes>} attachmentTypes
+            * @returns
+         */
+        setAttachmentTypes(attachmentTypes: Array<AttachmentType>): this;
         /**
             * This method will return an object of the MessagesRequest class.
             * @returns {MessagesRequest}
@@ -7687,4 +7810,3 @@ export class RTCUser {
     setResource(resource: string): void;
     getResource(): string;
 }
-