@cometchat/chat-sdk-javascript 4.1.3 → 4.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CometChat.d.ts +82 -0
- package/CometChat.js +1 -1
- package/package.json +1 -1
package/CometChat.d.ts
CHANGED
|
@@ -5000,6 +5000,12 @@ export class GroupsRequest {
|
|
|
5000
5000
|
* @return {boolean}
|
|
5001
5001
|
*/
|
|
5002
5002
|
isWithTags(): boolean;
|
|
5003
|
+
/**
|
|
5004
|
+
* Get the current page number that the request is on.
|
|
5005
|
+
*
|
|
5006
|
+
* @return {number}
|
|
5007
|
+
*/
|
|
5008
|
+
getPage(): number;
|
|
5003
5009
|
}
|
|
5004
5010
|
export class GroupsRequestBuilder {
|
|
5005
5011
|
/** @private */ limit: number;
|
|
@@ -5007,6 +5013,7 @@ export class GroupsRequestBuilder {
|
|
|
5007
5013
|
/** @private */ hasJoined: boolean;
|
|
5008
5014
|
/** @private */ tags: Array<String>;
|
|
5009
5015
|
/** @private */ showTags: boolean;
|
|
5016
|
+
/** @private */ page: number;
|
|
5010
5017
|
/**
|
|
5011
5018
|
*
|
|
5012
5019
|
* @param {number} limit
|
|
@@ -5041,6 +5048,13 @@ export class GroupsRequestBuilder {
|
|
|
5041
5048
|
* @returns
|
|
5042
5049
|
*/
|
|
5043
5050
|
withTags(withTags: boolean): this;
|
|
5051
|
+
/**
|
|
5052
|
+
*
|
|
5053
|
+
* @param {number} page
|
|
5054
|
+
* A method to set the page number to start fetching from. Page 0 will fetch the first page.
|
|
5055
|
+
* @returns
|
|
5056
|
+
*/
|
|
5057
|
+
setPage(page: number): this;
|
|
5044
5058
|
/**
|
|
5045
5059
|
* This method will return an object of the GroupsRequest class.
|
|
5046
5060
|
* @returns {GroupsRequest}
|
|
@@ -5084,6 +5098,12 @@ export class GroupMembersRequest {
|
|
|
5084
5098
|
* @return {String[]}
|
|
5085
5099
|
*/
|
|
5086
5100
|
getScopes(): String[];
|
|
5101
|
+
/**
|
|
5102
|
+
* Get the current page number that the request is on.
|
|
5103
|
+
*
|
|
5104
|
+
* @return {number}
|
|
5105
|
+
*/
|
|
5106
|
+
getPage(): number;
|
|
5087
5107
|
/**
|
|
5088
5108
|
* Gets the status filter used to fetch members based on their online or offline status.
|
|
5089
5109
|
*
|
|
@@ -5100,6 +5120,7 @@ export class GroupMembersRequestBuilder {
|
|
|
5100
5120
|
/** @private */ searchKeyword: string;
|
|
5101
5121
|
/** @private */ guid: string;
|
|
5102
5122
|
/** @private */ scopes?: Array<String>;
|
|
5123
|
+
/** @private */ page: number;
|
|
5103
5124
|
/** @private */ status: string;
|
|
5104
5125
|
constructor(guid: string);
|
|
5105
5126
|
/**
|
|
@@ -5130,6 +5151,13 @@ export class GroupMembersRequestBuilder {
|
|
|
5130
5151
|
* @returns
|
|
5131
5152
|
*/
|
|
5132
5153
|
setScopes(scopes: Array<String>): this;
|
|
5154
|
+
/**
|
|
5155
|
+
*
|
|
5156
|
+
* @param {number} page
|
|
5157
|
+
* A method to set the page number to start fetching from. Page 0 will fetch the first page.
|
|
5158
|
+
* @returns
|
|
5159
|
+
*/
|
|
5160
|
+
setPage(page: number): this;
|
|
5133
5161
|
/**
|
|
5134
5162
|
* A method to get the members belonging to a specific status.
|
|
5135
5163
|
* @param {string} status
|
|
@@ -5175,6 +5203,12 @@ export class BannedMembersRequest {
|
|
|
5175
5203
|
* @return {String[]}
|
|
5176
5204
|
*/
|
|
5177
5205
|
getScopes(): String[];
|
|
5206
|
+
/**
|
|
5207
|
+
* Get the current page number that the request is on.
|
|
5208
|
+
*
|
|
5209
|
+
* @return {number}
|
|
5210
|
+
*/
|
|
5211
|
+
getPage(): number;
|
|
5178
5212
|
/**
|
|
5179
5213
|
* @internal
|
|
5180
5214
|
*/
|
|
@@ -5185,6 +5219,7 @@ export class BannedMembersRequestBuilder {
|
|
|
5185
5219
|
/** @private */ searchKeyword: string;
|
|
5186
5220
|
/** @private */ guid: string;
|
|
5187
5221
|
/** @private */ scopes?: Array<String>;
|
|
5222
|
+
/** @private */ page: number;
|
|
5188
5223
|
constructor(guid: string);
|
|
5189
5224
|
/**
|
|
5190
5225
|
* Set the unique identifier of the group.
|
|
@@ -5214,6 +5249,13 @@ export class BannedMembersRequestBuilder {
|
|
|
5214
5249
|
* @returns
|
|
5215
5250
|
*/
|
|
5216
5251
|
setScopes(scopes: Array<String>): this;
|
|
5252
|
+
/**
|
|
5253
|
+
*
|
|
5254
|
+
* @param {number} page
|
|
5255
|
+
* A method to set the page number to start fetching from. Page 0 will fetch the first page.
|
|
5256
|
+
* @returns
|
|
5257
|
+
*/
|
|
5258
|
+
setPage(page: number): this;
|
|
5217
5259
|
/**
|
|
5218
5260
|
* This method will return an object of the BannedMembersRequest class.
|
|
5219
5261
|
* @returns {BannedMembersRequest}
|
|
@@ -5311,6 +5353,12 @@ export class UsersRequest {
|
|
|
5311
5353
|
* @return {string}
|
|
5312
5354
|
*/
|
|
5313
5355
|
getSortOrder(): string;
|
|
5356
|
+
/**
|
|
5357
|
+
* Get the current page number that the request is on.
|
|
5358
|
+
*
|
|
5359
|
+
* @return {number}
|
|
5360
|
+
*/
|
|
5361
|
+
getPage(): number;
|
|
5314
5362
|
/**
|
|
5315
5363
|
* 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.
|
|
5316
5364
|
* @returns {Promise<User[] | []>}
|
|
@@ -5335,6 +5383,7 @@ export class UsersRequestBuilder {
|
|
|
5335
5383
|
/** @private */ SortBy: string;
|
|
5336
5384
|
/** @private */ SortOrder: string;
|
|
5337
5385
|
/** @private */ SearchIn: Array<String>;
|
|
5386
|
+
/** @private */ page: number;
|
|
5338
5387
|
/**
|
|
5339
5388
|
* 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.
|
|
5340
5389
|
* @param {number} limit
|
|
@@ -5420,6 +5469,12 @@ export class UsersRequestBuilder {
|
|
|
5420
5469
|
* @returns
|
|
5421
5470
|
*/
|
|
5422
5471
|
searchIn(searchIn: Array<String>): this;
|
|
5472
|
+
/**
|
|
5473
|
+
* A method to set the page number to start fetching from. Page 0 will fetch the first page.
|
|
5474
|
+
* @param {number} page
|
|
5475
|
+
* @returns
|
|
5476
|
+
*/
|
|
5477
|
+
setPage(page: number): this;
|
|
5423
5478
|
/**
|
|
5424
5479
|
* This method will return an object of the UsersRequest class.
|
|
5425
5480
|
* @returns {UsersRequest}
|
|
@@ -5504,6 +5559,12 @@ export class ConversationsRequest {
|
|
|
5504
5559
|
* @returns {boolean}
|
|
5505
5560
|
*/
|
|
5506
5561
|
getUnread(): boolean;
|
|
5562
|
+
/**
|
|
5563
|
+
* Get the current page number that the request is on.
|
|
5564
|
+
*
|
|
5565
|
+
* @return {number}
|
|
5566
|
+
*/
|
|
5567
|
+
getPage(): number;
|
|
5507
5568
|
/**
|
|
5508
5569
|
* Determines whether agentic conversations should be hidden.
|
|
5509
5570
|
*
|
|
@@ -5529,6 +5590,7 @@ export class ConversationsRequestBuilder {
|
|
|
5529
5590
|
/** @private */ WithBlockedInfo: boolean;
|
|
5530
5591
|
/** @private */ searchKeyword: string;
|
|
5531
5592
|
/** @private */ unreadOnly: boolean;
|
|
5593
|
+
/** @private */ page: number;
|
|
5532
5594
|
/** @private */ hideAgentic: boolean;
|
|
5533
5595
|
/** @private */ onlyAgentic: boolean;
|
|
5534
5596
|
/**
|
|
@@ -5619,6 +5681,12 @@ export class ConversationsRequestBuilder {
|
|
|
5619
5681
|
* @returns
|
|
5620
5682
|
*/
|
|
5621
5683
|
setUnread(unread: boolean): this;
|
|
5684
|
+
/**
|
|
5685
|
+
* A method to set the page number to start fetching from. Page 0 will fetch the first page.
|
|
5686
|
+
* @param {number} page
|
|
5687
|
+
* @returns
|
|
5688
|
+
*/
|
|
5689
|
+
setPage(page: number): this;
|
|
5622
5690
|
/**
|
|
5623
5691
|
* A method to hide agentic conversations from the list.
|
|
5624
5692
|
* @param {boolean} hideAgentic
|
|
@@ -6275,6 +6343,12 @@ export class BlockedUsersRequest {
|
|
|
6275
6343
|
* @return {string}
|
|
6276
6344
|
*/
|
|
6277
6345
|
getSearchKeyword(): string;
|
|
6346
|
+
/**
|
|
6347
|
+
* Get the current page number that the request is on.
|
|
6348
|
+
*
|
|
6349
|
+
* @return {number}
|
|
6350
|
+
*/
|
|
6351
|
+
getPage(): number;
|
|
6278
6352
|
/** @internal */
|
|
6279
6353
|
getNextData(): any;
|
|
6280
6354
|
}
|
|
@@ -6282,6 +6356,7 @@ export class BlockedUsersRequestBuilder {
|
|
|
6282
6356
|
/** @private */ limit: number;
|
|
6283
6357
|
/** @private */ searchKeyword: string;
|
|
6284
6358
|
/** @private */ direction: string;
|
|
6359
|
+
/** @private */ page: number;
|
|
6285
6360
|
/**
|
|
6286
6361
|
*
|
|
6287
6362
|
* @param {number} limit
|
|
@@ -6303,6 +6378,13 @@ export class BlockedUsersRequestBuilder {
|
|
|
6303
6378
|
* @returns
|
|
6304
6379
|
*/
|
|
6305
6380
|
setDirection(direction: string): this;
|
|
6381
|
+
/**
|
|
6382
|
+
*
|
|
6383
|
+
* @param {number} page
|
|
6384
|
+
* A method to set the page number to start fetching from. Page 0 will fetch the first page.
|
|
6385
|
+
* @returns
|
|
6386
|
+
*/
|
|
6387
|
+
setPage(page: number): this;
|
|
6306
6388
|
/** @internal */
|
|
6307
6389
|
blockedByMe(): this;
|
|
6308
6390
|
/** @internal */
|