@cometchat/chat-sdk-javascript 4.0.10 → 4.0.12

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,11 @@ 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;
                         };
                 };
         };
@@ -483,6 +488,9 @@ export class CometChat {
                         ENDED: string;
                 };
         };
+        /**
+            * @deprecated Use `PresenceConstants` instead.
+            */
         static PresenceConstatnts: {
                 STATUS: {
                         ONLINE: string;
@@ -492,6 +500,15 @@ export class CometChat {
                         LEFT: string;
                 };
         };
+        static PresenceConstants: {
+                STATUS: {
+                        ONLINE: string;
+                        AVAILABLE: string;
+                        OFFLINE: string;
+                        JOINED: string;
+                        LEFT: string;
+                };
+        };
         static APPINFO: {
                 platform: string;
                 sdkVersion: string;
@@ -976,6 +993,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;
@@ -3029,6 +3047,11 @@ 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;
         };
     };
 };
@@ -3662,6 +3685,9 @@ export const FeatureRestrictionErrors: {
         details: {};
     };
 };
+/**
+  * @deprecated Use `PresenceConstants` instead.
+  */
 export const PresenceConstatnts: {
     STATUS: {
         ONLINE: string;
@@ -3671,6 +3697,15 @@ export const PresenceConstatnts: {
         LEFT: string;
     };
 };
+export const PresenceConstants: {
+    STATUS: {
+        ONLINE: string;
+        AVAILABLE: string;
+        OFFLINE: string;
+        JOINED: string;
+        LEFT: string;
+    };
+};
 export const APP_SETTINGS: {
     APP_SETTINGS: string;
     KEYS: {
@@ -5218,6 +5253,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.
@@ -5248,6 +5288,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;
@@ -5259,6 +5305,8 @@ export class ConversationsRequestBuilder {
         /** @private */ userTags: Array<String>;
         /** @private */ IncludeBlockedUsers: boolean;
         /** @private */ WithBlockedInfo: boolean;
+        /** @private */ searchKeyword: string;
+        /** @private */ unreadOnly: boolean;
         /**
             *
             * @param {number} limit
@@ -5273,6 +5321,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
@@ -5333,6 +5389,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}
@@ -5446,6 +5508,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.
             *
@@ -5511,6 +5603,11 @@ 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>;
         /**
             * 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
@@ -5613,6 +5710,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
@@ -7070,6 +7197,99 @@ export class ConversationUpdateSettings {
     static fromJSON(jsonData: Object): ConversationUpdateSettings;
 }
 
+/**
+    *
+    * @module MessageReceipt
+    */
+export class MessageReceipt {
+        RECEIPT_TYPE: {
+                READ_RECEIPT: string;
+                DELIVERY_RECEIPT: string;
+                READ_BY_ALL_RECEIPT: string;
+                DELIVERED_TO_ALL_RECEIPT: string;
+        };
+        /**
+            * Method to get receiver type of the message receipt.
+            * @returns {string}
+         */
+        getReceiverType(): string;
+        /**
+            * Method to set receiver type of the message receipt.
+            * @param {string} receiverType
+         */
+        setReceiverType(receiverType: string): void;
+        /**
+            * Method to get sender of the message receipt.
+            * @returns {User}
+         */
+        getSender(): User;
+        /**
+            * Method to set sender of the message receipt.
+            * @param {User} sender
+         */
+        setSender(sender: User): void;
+        /**
+            * Method to get receiver of the message receipt.
+            * @returns {string}
+         */
+        getReceiver(): string;
+        /**
+            * Method to set receiver of the message receipt.
+            * @param {string} receiver
+         */
+        setReceiver(receiver: string): void;
+        /**
+            * Method to get timestamp of the message receipt.
+            * @returns {string}
+         */
+        getTimestamp(): string;
+        /**
+            * Method to set timestamp of the message receipt.
+            * @param {string} timestamp
+         */
+        setTimestamp(timestamp: string): void;
+        /**
+            * Method to set readAt timestamp of the message receipt.
+            * @param {number} readAt
+         */
+        setReadAt(readAt: number): void;
+        /**
+            * Method to get readAt timestamp of the message receipt.
+            * @returns {number}
+         */
+        getReadAt(): number;
+        /**
+            * Method to set deliveredAt timestamp of the message receipt.
+            * @param {number} deliveredAt
+         */
+        setDeliveredAt(deliveredAt: number): void;
+        /**
+            * Method to get deliveredAt timestamp of the message receipt.
+            * @returns {number}
+         */
+        getDeliveredAt(): number;
+        /**
+            * Method to get the message ID.
+            * @returns {string}
+         */
+        getMessageId(): string;
+        /**
+            * Method to set the message ID.
+            * @param {string} messageId
+         */
+        setMessageId(messageId: string): void;
+        /**
+            * Method to get the receipt type of message receipt.
+            * @returns {string}
+         */
+        getReceiptType(): string;
+        /**
+            * Method to set the receipt type of message receipt.
+            * @param {string} receiptType
+         */
+        setReceiptType(receiptType?: string): void;
+}
+
 /** Push Notification Preferences Enums */
 export enum MessagesOptions {
     DONT_SUBSCRIBE,
@@ -7556,99 +7776,6 @@ export interface ErrorModel {
     details?: string;
 }
 
-/**
-    *
-    * @module MessageReceipt
-    */
-export class MessageReceipt {
-        RECEIPT_TYPE: {
-                READ_RECEIPT: string;
-                DELIVERY_RECEIPT: string;
-                READ_BY_ALL_RECEIPT: string;
-                DELIVERED_TO_ALL_RECEIPT: string;
-        };
-        /**
-            * Method to get receiver type of the message receipt.
-            * @returns {string}
-         */
-        getReceiverType(): string;
-        /**
-            * Method to set receiver type of the message receipt.
-            * @param {string} receiverType
-         */
-        setReceiverType(receiverType: string): void;
-        /**
-            * Method to get sender of the message receipt.
-            * @returns {User}
-         */
-        getSender(): User;
-        /**
-            * Method to set sender of the message receipt.
-            * @param {User} sender
-         */
-        setSender(sender: User): void;
-        /**
-            * Method to get receiver of the message receipt.
-            * @returns {string}
-         */
-        getReceiver(): string;
-        /**
-            * Method to set receiver of the message receipt.
-            * @param {string} receiver
-         */
-        setReceiver(receiver: string): void;
-        /**
-            * Method to get timestamp of the message receipt.
-            * @returns {string}
-         */
-        getTimestamp(): string;
-        /**
-            * Method to set timestamp of the message receipt.
-            * @param {string} timestamp
-         */
-        setTimestamp(timestamp: string): void;
-        /**
-            * Method to set readAt timestamp of the message receipt.
-            * @param {number} readAt
-         */
-        setReadAt(readAt: number): void;
-        /**
-            * Method to get readAt timestamp of the message receipt.
-            * @returns {number}
-         */
-        getReadAt(): number;
-        /**
-            * Method to set deliveredAt timestamp of the message receipt.
-            * @param {number} deliveredAt
-         */
-        setDeliveredAt(deliveredAt: number): void;
-        /**
-            * Method to get deliveredAt timestamp of the message receipt.
-            * @returns {number}
-         */
-        getDeliveredAt(): number;
-        /**
-            * Method to get the message ID.
-            * @returns {string}
-         */
-        getMessageId(): string;
-        /**
-            * Method to set the message ID.
-            * @param {string} messageId
-         */
-        setMessageId(messageId: string): void;
-        /**
-            * Method to get the receipt type of message receipt.
-            * @returns {string}
-         */
-        getReceiptType(): string;
-        /**
-            * Method to set the receipt type of message receipt.
-            * @param {string} receiptType
-         */
-        setReceiptType(receiptType?: string): void;
-}
-
 export class RTCUser {
     constructor(uid: string);
     setUID(uid: string): void;
@@ -7662,4 +7789,3 @@ export class RTCUser {
     setResource(resource: string): void;
     getResource(): string;
 }
-