@cometchat/chat-sdk-javascript 4.1.3 → 4.1.5

package/CometChat.d.ts

@@ -300,7 +300,7 @@ export class CometChat {
                 };
                 SESSION_ID_REQUIRED: {
                         code: string;
-                        /** @internal */ name: string;
+                        name: string;
                         message: string;
                         details: {};
                 };
@@ -493,6 +493,7 @@ export class CometChat {
                         CORE_CONVERSATIONS_UPDATE_ON_GROUP_ACTIONS: string;
                         CORE_CONVERSATIONS_UPDATE_ON_CUSTOM_MESSAGES: string;
                         CORE_CONVERSATIONS_UPDATE_ON_REPLIES: string;
+                        FLAG_REASONS: string;
                 };
         };
         static GroupConstants: {
@@ -2072,6 +2073,26 @@ export class CometChat {
             * @return A ConversationUpdateSettings object that holds the settings for updating the conversation.
          */
         static getConversationUpdateSettings(): Promise<ConversationUpdateSettings>;
+        /**
+            * Fetches the list of flag reasons configured in the CometChat Dashboard.
+            * @returns {Promise<FlagReason[]>}
+            * @memberof CometChat
+            */
+        static getFlagReasons(): Promise<FlagReason[]>;
+        /**
+            * Allows users to flag a message with a specific reason and an optional remark.
+            * @param {string} messageId
+            * @param {{ reasonId?: string; remark?: string }} payload
+            * @returns {Promise<{ success: boolean; message: string }>}
+            * @memberof CometChat
+            */
+        static flagMessage(messageId: string, payload: {
+                reasonId: string;
+                remark?: string;
+        }): Promise<{
+                success: boolean;
+                message: string;
+        }>;
 }
 
 export class CometChatNotifications {
@@ -3894,6 +3915,7 @@ export const APP_SETTINGS: {
         CORE_CONVERSATIONS_UPDATE_ON_GROUP_ACTIONS: string;
         CORE_CONVERSATIONS_UPDATE_ON_CUSTOM_MESSAGES: string;
         CORE_CONVERSATIONS_UPDATE_ON_REPLIES: string;
+        FLAG_REASONS: string;
     };
 };
 export const COMMON_UTILITY_CONSTANTS: {
@@ -4002,6 +4024,14 @@ export const AI_ASSISTANT_EVENTS: {
     TOOL_CALL_RESULT: string;
     TOOL_CALL_ARGUMENT: string;
 };
+export interface FlagReason {
+    id: string;
+    name: string;
+    description: string;
+    default?: boolean;
+    createdAt: number;
+    updatedAt: number;
+}
 
 /**
     *
@@ -4523,12 +4553,6 @@ export class Call extends BaseMessage implements Message {
                 MEDIA: string;
                 IMAGE: string;
                 VIDEO: string;
-                AUDIO: string;
-                FILE: string;
-                CUSTOM: string;
-                ASSISTANT: string;
-                TOOL_RESULT: string;
-                TOOL_ARGUMENTS: string;
         };
         static readonly RECEIVER_TYPE: {
                 USER: string;
@@ -4540,7 +4564,6 @@ export class Call extends BaseMessage implements Message {
                 CALL: string;
                 CUSTOM: string;
                 INTERACTIVE: string;
-                AGENTIC: string;
         };
         static readonly ACTION_TYPE: {
                 TYPE_MEMBER_JOINED: string;
@@ -5000,6 +5023,12 @@ export class GroupsRequest {
             * @return {boolean}
             */
         isWithTags(): boolean;
+        /**
+            * Get the current page number that the request is on.
+            *
+            * @return {number}
+            */
+        getPage(): number;
 }
 export class GroupsRequestBuilder {
         /** @private */ limit: number;
@@ -5007,6 +5036,7 @@ export class GroupsRequestBuilder {
         /** @private */ hasJoined: boolean;
         /** @private */ tags: Array<String>;
         /** @private */ showTags: boolean;
+        /** @private */ page: number;
         /**
             *
             * @param {number} limit
@@ -5041,6 +5071,13 @@ export class GroupsRequestBuilder {
             * @returns
          */
         withTags(withTags: boolean): this;
+        /**
+            *
+            * @param {number} page
+            * A method to set the page number to start fetching from. Page 0 will fetch the first page.
+            * @returns
+         */
+        setPage(page: number): this;
         /**
             * This method will return an object of the GroupsRequest class.
             * @returns {GroupsRequest}
@@ -5084,6 +5121,12 @@ export class GroupMembersRequest {
             * @return {String[]}
             */
         getScopes(): String[];
+        /**
+            * Get the current page number that the request is on.
+            *
+            * @return {number}
+            */
+        getPage(): number;
         /**
             * Gets the status filter used to fetch members based on their online or offline status.
             *
@@ -5100,6 +5143,7 @@ export class GroupMembersRequestBuilder {
         /** @private */ searchKeyword: string;
         /** @private */ guid: string;
         /** @private */ scopes?: Array<String>;
+        /** @private */ page: number;
         /** @private */ status: string;
         constructor(guid: string);
         /**
@@ -5130,6 +5174,13 @@ export class GroupMembersRequestBuilder {
             * @returns
          */
         setScopes(scopes: Array<String>): this;
+        /**
+            *
+            * @param {number} page
+            * A method to set the page number to start fetching from. Page 0 will fetch the first page.
+            * @returns
+         */
+        setPage(page: number): this;
         /**
             * A method to get the members belonging to a specific status.
             * @param {string} status
@@ -5175,6 +5226,12 @@ export class BannedMembersRequest {
             * @return {String[]}
             */
         getScopes(): String[];
+        /**
+            * Get the current page number that the request is on.
+            *
+            * @return {number}
+            */
+        getPage(): number;
         /**
             * @internal
             */
@@ -5185,6 +5242,7 @@ export class BannedMembersRequestBuilder {
         /** @private */ searchKeyword: string;
         /** @private */ guid: string;
         /** @private */ scopes?: Array<String>;
+        /** @private */ page: number;
         constructor(guid: string);
         /**
             * Set the unique identifier of the group.
@@ -5214,6 +5272,13 @@ export class BannedMembersRequestBuilder {
             * @returns
          */
         setScopes(scopes: Array<String>): this;
+        /**
+            *
+            * @param {number} page
+            * A method to set the page number to start fetching from. Page 0 will fetch the first page.
+            * @returns
+         */
+        setPage(page: number): this;
         /**
             * This method will return an object of the BannedMembersRequest class.
             * @returns {BannedMembersRequest}
@@ -5311,6 +5376,12 @@ export class UsersRequest {
             * @return {string}
             */
         getSortOrder(): string;
+        /**
+            * Get the current page number that the request is on.
+            *
+            * @return {number}
+            */
+        getPage(): number;
         /**
             * Get list of next set of users based on the parameters specified in UsersRequestBuilder class The Developer need to call this method repeatedly using the same object of UsersRequestBuilder class to get paginated list of users.
             * @returns {Promise<User[] | []>}
@@ -5335,6 +5406,7 @@ export class UsersRequestBuilder {
         /** @private */ SortBy: string;
         /** @private */ SortOrder: string;
         /** @private */ SearchIn: Array<String>;
+        /** @private */ page: number;
         /**
             * A method to set limit for the number of Users returned in a single iteration. A maximum of 100 users can fetched in a single iteration.
             * @param {number} limit
@@ -5420,6 +5492,12 @@ export class UsersRequestBuilder {
             * @returns
          */
         searchIn(searchIn: Array<String>): this;
+        /**
+            * A method to set the page number to start fetching from. Page 0 will fetch the first page.
+            * @param {number} page
+            * @returns
+         */
+        setPage(page: number): this;
         /**
             * This method will return an object of the UsersRequest class.
             * @returns {UsersRequest}
@@ -5504,6 +5582,12 @@ export class ConversationsRequest {
             * @returns {boolean}
          */
         getUnread(): boolean;
+        /**
+            * Get the current page number that the request is on.
+            *
+            * @return {number}
+            */
+        getPage(): number;
         /**
             * Determines whether agentic conversations should be hidden.
             *
@@ -5529,6 +5613,7 @@ export class ConversationsRequestBuilder {
         /** @private */ WithBlockedInfo: boolean;
         /** @private */ searchKeyword: string;
         /** @private */ unreadOnly: boolean;
+        /** @private */ page: number;
         /** @private */ hideAgentic: boolean;
         /** @private */ onlyAgentic: boolean;
         /**
@@ -5619,6 +5704,12 @@ export class ConversationsRequestBuilder {
             * @returns
          */
         setUnread(unread: boolean): this;
+        /**
+            * A method to set the page number to start fetching from. Page 0 will fetch the first page.
+            * @param {number} page
+            * @returns
+         */
+        setPage(page: number): this;
         /**
             * A method to hide agentic conversations from the list.
             * @param {boolean} hideAgentic
@@ -6275,6 +6366,12 @@ export class BlockedUsersRequest {
             * @return {string}
             */
         getSearchKeyword(): string;
+        /**
+            * Get the current page number that the request is on.
+            *
+            * @return {number}
+            */
+        getPage(): number;
         /** @internal */
         getNextData(): any;
 }
@@ -6282,6 +6379,7 @@ export class BlockedUsersRequestBuilder {
         /** @private */ limit: number;
         /** @private */ searchKeyword: string;
         /** @private */ direction: string;
+        /** @private */ page: number;
         /**
             *
             * @param {number} limit
@@ -6303,6 +6401,13 @@ export class BlockedUsersRequestBuilder {
             * @returns
          */
         setDirection(direction: string): this;
+        /**
+            *
+            * @param {number} page
+            * A method to set the page number to start fetching from. Page 0 will fetch the first page.
+            * @returns
+         */
+        setPage(page: number): this;
         /** @internal */
         blockedByMe(): this;
         /** @internal */