@cometchat/chat-sdk-javascript 4.0.1 → 4.0.3
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 +600 -70
- package/CometChat.js +1 -1
- package/package.json +1 -1
package/CometChat.d.ts
CHANGED
|
@@ -18,6 +18,8 @@ export class CometChat {
|
|
|
18
18
|
KEY_DATA: string;
|
|
19
19
|
KEY_META: string;
|
|
20
20
|
KEY_CURSOR: string;
|
|
21
|
+
KEY_NEXT: string;
|
|
22
|
+
KEY_PREVIOUS: string;
|
|
21
23
|
KEY_ACTION: string;
|
|
22
24
|
KEY_MESSAGE: string;
|
|
23
25
|
KEY_ERROR: string;
|
|
@@ -29,6 +31,7 @@ export class CometChat {
|
|
|
29
31
|
KEY_IDENTITY: string;
|
|
30
32
|
KEY_SERVICE: string;
|
|
31
33
|
KEY_ENTITIES: string;
|
|
34
|
+
KEY_REACTIONS: string;
|
|
32
35
|
KEY_ENTITITY: string;
|
|
33
36
|
KEY_ENTITYTYPE: string;
|
|
34
37
|
KEY_ATTACHMENTS: string;
|
|
@@ -307,6 +310,7 @@ export class CometChat {
|
|
|
307
310
|
ACTION: string;
|
|
308
311
|
CALL: string;
|
|
309
312
|
CUSTOM: string;
|
|
313
|
+
INTERACTIVE: string;
|
|
310
314
|
};
|
|
311
315
|
RECEIVER_TYPE: {
|
|
312
316
|
USER: string;
|
|
@@ -335,6 +339,14 @@ export class CometChat {
|
|
|
335
339
|
CUSTOM_DATA: string;
|
|
336
340
|
CUSTOM_SUB_TYPE: string;
|
|
337
341
|
RESOURCE: string;
|
|
342
|
+
MENTIONS: string;
|
|
343
|
+
INTERACTIVE_DATA: string;
|
|
344
|
+
INTERACTION_GOAL: string;
|
|
345
|
+
INTERACTIONS: string;
|
|
346
|
+
ALLOW_SENDER_INTERACTION: string;
|
|
347
|
+
ELEMENT_ID: string;
|
|
348
|
+
INTERACTED_AT: string;
|
|
349
|
+
ELEMENT_IDS: string;
|
|
338
350
|
};
|
|
339
351
|
KNOWN_MEDIA_TYPE: {
|
|
340
352
|
IMAGE: any[];
|
|
@@ -376,6 +388,10 @@ export class CometChat {
|
|
|
376
388
|
HIDE_DELETED_MESSAGES: string;
|
|
377
389
|
WITH_TAGS: string;
|
|
378
390
|
TAGS: string;
|
|
391
|
+
MY_MENTIONS_ONLY: string;
|
|
392
|
+
MENTIONS_WITH_TAG_INFO: string;
|
|
393
|
+
MENTIONS_WITH_BLOCKED_INFO: string;
|
|
394
|
+
ONLY_INTERACTION_GOAL_COMPLETED: string;
|
|
379
395
|
};
|
|
380
396
|
};
|
|
381
397
|
};
|
|
@@ -703,6 +719,7 @@ export class CometChat {
|
|
|
703
719
|
static SESSION_STORE: {
|
|
704
720
|
SESSION_ID: string;
|
|
705
721
|
};
|
|
722
|
+
static REACTION_ACTION: typeof REACTION_ACTION;
|
|
706
723
|
static ExtensionErrors: {
|
|
707
724
|
INVALID_EXTENSION: {
|
|
708
725
|
code: string;
|
|
@@ -860,6 +877,7 @@ export class CometChat {
|
|
|
860
877
|
static DEFAULT_VALUES: {
|
|
861
878
|
ZERO: number;
|
|
862
879
|
MSGS_LIMIT: number;
|
|
880
|
+
REACTIONS_LIMIT: number;
|
|
863
881
|
MSGS_MAX_LIMIT: number;
|
|
864
882
|
USERS_LIMIT: number;
|
|
865
883
|
USERS_MAX_LIMIT: number;
|
|
@@ -938,6 +956,7 @@ export class CometChat {
|
|
|
938
956
|
MSG_VER_PRE: string;
|
|
939
957
|
MSG_VER_POST: string;
|
|
940
958
|
};
|
|
959
|
+
static GoalType: typeof GoalType;
|
|
941
960
|
static CometChatException: typeof CometChatException;
|
|
942
961
|
static TextMessage: typeof TextMessage;
|
|
943
962
|
static MediaMessage: typeof MediaMessage;
|
|
@@ -947,6 +966,10 @@ export class CometChat {
|
|
|
947
966
|
static Call: typeof Call;
|
|
948
967
|
static TypingIndicator: typeof TypingIndicator;
|
|
949
968
|
static TransientMessage: typeof TransientMessage;
|
|
969
|
+
static InteractiveMessage: typeof InteractiveMessage;
|
|
970
|
+
static InteractionGoal: typeof InteractionGoal;
|
|
971
|
+
static Interaction: typeof Interaction;
|
|
972
|
+
static InteractionReceipt: typeof InteractionReceipt;
|
|
950
973
|
static Group: typeof Group;
|
|
951
974
|
static User: typeof User;
|
|
952
975
|
static GroupMember: typeof GroupMember;
|
|
@@ -957,6 +980,8 @@ export class CometChat {
|
|
|
957
980
|
};
|
|
958
981
|
static MessagesRequest: typeof MessagesRequest;
|
|
959
982
|
static MessagesRequestBuilder: typeof MessagesRequestBuilder;
|
|
983
|
+
static ReactionRequest: typeof ReactionRequest;
|
|
984
|
+
static ReactionRequestBuilder: typeof ReactionRequestBuilder;
|
|
960
985
|
static UsersRequest: typeof UsersRequest;
|
|
961
986
|
static UsersRequestBuilder: typeof UsersRequestBuilder;
|
|
962
987
|
static ConversationsRequest: typeof ConversationsRequest;
|
|
@@ -1000,6 +1025,7 @@ export class CometChat {
|
|
|
1000
1025
|
static CATEGORY_ACTION: string;
|
|
1001
1026
|
static CATEGORY_CALL: string;
|
|
1002
1027
|
static CATEGORY_CUSTOM: string;
|
|
1028
|
+
static CATEGORY_INTERACTIVE: string;
|
|
1003
1029
|
static ACTION_TYPE: {
|
|
1004
1030
|
MEMBER_ADDED: string;
|
|
1005
1031
|
MEMBER_JOINED: string;
|
|
@@ -1196,11 +1222,11 @@ export class CometChat {
|
|
|
1196
1222
|
*--------------------------------------------------------------------**/
|
|
1197
1223
|
/**
|
|
1198
1224
|
* Function to send message.
|
|
1199
|
-
* @param {TextMessage | MediaMessage | CustomMessage | any} message
|
|
1225
|
+
* @param {TextMessage | MediaMessage | CustomMessage | InteractiveMessage |any} message
|
|
1200
1226
|
* @returns {Message | any}
|
|
1201
1227
|
* @memberof CometChat
|
|
1202
1228
|
*/
|
|
1203
|
-
static sendMessage(message: TextMessage | MediaMessage | CustomMessage | any): Promise<TextMessage | MediaMessage | CustomMessage | BaseMessage>;
|
|
1229
|
+
static sendMessage(message: TextMessage | MediaMessage | CustomMessage | InteractiveMessage | any): Promise<TextMessage | MediaMessage | CustomMessage | BaseMessage>;
|
|
1204
1230
|
/**
|
|
1205
1231
|
* Function to send a message to user.
|
|
1206
1232
|
* @internal
|
|
@@ -1232,6 +1258,14 @@ export class CometChat {
|
|
|
1232
1258
|
* @memberof CometChat
|
|
1233
1259
|
*/
|
|
1234
1260
|
static sendCustomMessage(message: CustomMessage): Promise<TextMessage | BaseMessage | MediaMessage | CustomMessage>;
|
|
1261
|
+
/**
|
|
1262
|
+
*
|
|
1263
|
+
* Function to send a interactive message.
|
|
1264
|
+
* @param {InteractiveMessage} message
|
|
1265
|
+
* @returns {Message | any}
|
|
1266
|
+
* @memberof CometChat
|
|
1267
|
+
*/
|
|
1268
|
+
static sendInteractiveMessage(message: InteractiveMessage): Promise<TextMessage | BaseMessage | MediaMessage | CustomMessage>;
|
|
1235
1269
|
/**
|
|
1236
1270
|
*
|
|
1237
1271
|
* Function to get the last delivered message id from local storage.
|
|
@@ -1267,6 +1301,13 @@ export class CometChat {
|
|
|
1267
1301
|
* @memberof CometChat
|
|
1268
1302
|
*/
|
|
1269
1303
|
static markAsDelivered(...args: any): any;
|
|
1304
|
+
/**
|
|
1305
|
+
* Mark all the messages after the specified message id as unread.
|
|
1306
|
+
* @param {TextMessage | MediaMessage | CustomMessage | BaseMessage | any} message
|
|
1307
|
+
* @returns {Promise<string>}
|
|
1308
|
+
* @memberof CometChat
|
|
1309
|
+
**/
|
|
1310
|
+
static markAsUnread(message: TextMessage | MediaMessage | CustomMessage | any): Promise<string | CometChatException>;
|
|
1270
1311
|
/**
|
|
1271
1312
|
* Send a transient message.
|
|
1272
1313
|
* @param {string} uid
|
|
@@ -1287,7 +1328,7 @@ export class CometChat {
|
|
|
1287
1328
|
* @returns {Message | any}
|
|
1288
1329
|
* @memberof CometChat
|
|
1289
1330
|
*/
|
|
1290
|
-
static getMessageDetails(messageId: string | any): Promise<TextMessage | MediaMessage | CustomMessage | BaseMessage>;
|
|
1331
|
+
static getMessageDetails(messageId: string | any): Promise<TextMessage | MediaMessage | CustomMessage | InteractiveMessage | BaseMessage>;
|
|
1291
1332
|
/**
|
|
1292
1333
|
* Function to fetch message receipt details for the provided messageID.
|
|
1293
1334
|
* @param {string | any} messageId
|
|
@@ -1332,6 +1373,22 @@ export class CometChat {
|
|
|
1332
1373
|
* @memberof CometChat
|
|
1333
1374
|
*/
|
|
1334
1375
|
static getUnreadMessageCountForGroup(GUID: string, doHideMessages?: boolean): Promise<Object>;
|
|
1376
|
+
/**
|
|
1377
|
+
* Function to add reaction for the provided messageID.
|
|
1378
|
+
* @param {string | any} messageId
|
|
1379
|
+
* @param {string} reaction
|
|
1380
|
+
* @returns {Promise<BaseMessage>}
|
|
1381
|
+
* @memberof CometChat
|
|
1382
|
+
*/
|
|
1383
|
+
static addReaction(messageId: string | any, reaction: string): Promise<BaseMessage>;
|
|
1384
|
+
/**
|
|
1385
|
+
* Function to remove reaction for the provided messageID.
|
|
1386
|
+
* @param {string | any} messageId
|
|
1387
|
+
* @param {string} reaction
|
|
1388
|
+
* @returns {Promise<BaseMessage>}
|
|
1389
|
+
* @memberof CometChat
|
|
1390
|
+
*/
|
|
1391
|
+
static removeReaction(messageId: string | any, reaction: string): Promise<BaseMessage>;
|
|
1335
1392
|
/**
|
|
1336
1393
|
* Funtion to edit a message.
|
|
1337
1394
|
* @param {BaseMessage} message
|
|
@@ -1898,6 +1955,13 @@ export class CometChat {
|
|
|
1898
1955
|
* @returns
|
|
1899
1956
|
*/
|
|
1900
1957
|
internalLogout(pushToLoginListener?: boolean): Promise<unknown>;
|
|
1958
|
+
/**
|
|
1959
|
+
* Mark the element of a message as interacted.
|
|
1960
|
+
* @param {string} messageId
|
|
1961
|
+
* @param {string} elementId
|
|
1962
|
+
* @memberof CometChat
|
|
1963
|
+
*/
|
|
1964
|
+
static markAsInteracted(messageId: string | any, elementId: string): Promise<string>;
|
|
1901
1965
|
}
|
|
1902
1966
|
|
|
1903
1967
|
/**
|
|
@@ -1921,7 +1985,7 @@ export interface UserObj {
|
|
|
1921
1985
|
avatar: string;
|
|
1922
1986
|
lastActiveAt: number;
|
|
1923
1987
|
link: string;
|
|
1924
|
-
metadata:
|
|
1988
|
+
metadata: object;
|
|
1925
1989
|
role: string;
|
|
1926
1990
|
status: string;
|
|
1927
1991
|
statusMessage: string;
|
|
@@ -1994,14 +2058,14 @@ export class User {
|
|
|
1994
2058
|
setLink(link: string): string;
|
|
1995
2059
|
/**
|
|
1996
2060
|
* Method to get metadata of the user.
|
|
1997
|
-
* @returns {
|
|
2061
|
+
* @returns {object}
|
|
1998
2062
|
*/
|
|
1999
|
-
getMetadata():
|
|
2063
|
+
getMetadata(): object;
|
|
2000
2064
|
/**
|
|
2001
2065
|
* Method to set metadata of the user.
|
|
2002
|
-
* @param {
|
|
2066
|
+
* @param {object} metadata
|
|
2003
2067
|
*/
|
|
2004
|
-
setMetadata(metadata:
|
|
2068
|
+
setMetadata(metadata: object): void;
|
|
2005
2069
|
/**
|
|
2006
2070
|
* Method to get role of the user.
|
|
2007
2071
|
* @returns {string}
|
|
@@ -2097,6 +2161,7 @@ export class MediaMessage extends BaseMessage implements Message {
|
|
|
2097
2161
|
ACTION: string;
|
|
2098
2162
|
CALL: string;
|
|
2099
2163
|
CUSTOM: string;
|
|
2164
|
+
INTERACTIVE: string;
|
|
2100
2165
|
};
|
|
2101
2166
|
private url;
|
|
2102
2167
|
private file;
|
|
@@ -2203,6 +2268,8 @@ export class BaseMessage implements Message {
|
|
|
2203
2268
|
protected sender?: User;
|
|
2204
2269
|
protected receiverId?: string;
|
|
2205
2270
|
protected receiver?: User | Group;
|
|
2271
|
+
protected data?: object;
|
|
2272
|
+
protected reactions?: ReactionCount[];
|
|
2206
2273
|
protected type?: string;
|
|
2207
2274
|
protected category?: MessageCategory;
|
|
2208
2275
|
protected receiverType?: string;
|
|
@@ -2222,106 +2289,119 @@ export class BaseMessage implements Message {
|
|
|
2222
2289
|
protected deletedBy: string;
|
|
2223
2290
|
protected replyCount: number;
|
|
2224
2291
|
protected rawMessage: Object;
|
|
2292
|
+
protected unreadRepliesCount: number;
|
|
2293
|
+
protected mentionedUsers?: User[];
|
|
2294
|
+
protected mentionedMe?: boolean;
|
|
2225
2295
|
constructor(receiverId: string, messageType: string, receiverType: string, category: MessageCategory);
|
|
2296
|
+
/**
|
|
2297
|
+
* Get unread replies count of the message
|
|
2298
|
+
* @returns {number}
|
|
2299
|
+
*/
|
|
2300
|
+
getUnreadRepliesCount(): number;
|
|
2301
|
+
/**
|
|
2302
|
+
* @param {number}
|
|
2303
|
+
* Set unread replies count of the message
|
|
2304
|
+
*/
|
|
2305
|
+
setUnreadRepliesCount(value: number): void;
|
|
2226
2306
|
/**
|
|
2227
2307
|
* Get ID of the message
|
|
2228
2308
|
* @returns {number}
|
|
2229
|
-
|
|
2309
|
+
*/
|
|
2230
2310
|
getId(): number;
|
|
2231
2311
|
/**
|
|
2232
2312
|
* @param {number} value
|
|
2233
2313
|
* Set ID of the message
|
|
2234
|
-
|
|
2314
|
+
*/
|
|
2235
2315
|
setId(value: number): void;
|
|
2236
2316
|
/**
|
|
2237
2317
|
* Get conversation ID of the message.
|
|
2238
2318
|
* @returns {string}
|
|
2239
|
-
|
|
2319
|
+
*/
|
|
2240
2320
|
getConversationId(): string;
|
|
2241
2321
|
/**
|
|
2242
2322
|
* @param {string} value
|
|
2243
2323
|
* Set conversation ID of the message.
|
|
2244
|
-
|
|
2324
|
+
*/
|
|
2245
2325
|
setConversationId(value: string): void;
|
|
2246
2326
|
/**
|
|
2247
2327
|
* Get parent message ID of the message.
|
|
2248
2328
|
* @returns {number}
|
|
2249
|
-
|
|
2329
|
+
*/
|
|
2250
2330
|
getParentMessageId(): number;
|
|
2251
2331
|
/**
|
|
2252
2332
|
* @param {number} value
|
|
2253
2333
|
* Set parent message ID of the message.
|
|
2254
|
-
|
|
2334
|
+
*/
|
|
2255
2335
|
setParentMessageId(value: number): void;
|
|
2256
2336
|
/**
|
|
2257
2337
|
* Get MUID of the message.
|
|
2258
2338
|
* @returns {string}
|
|
2259
|
-
|
|
2339
|
+
*/
|
|
2260
2340
|
getMuid(): string;
|
|
2261
2341
|
/**
|
|
2262
2342
|
* @param {string} value
|
|
2263
2343
|
* Sets the MUID of the message.
|
|
2264
|
-
|
|
2344
|
+
*/
|
|
2265
2345
|
setMuid(value: string): void;
|
|
2266
2346
|
/**
|
|
2267
2347
|
* Get sender of the message.
|
|
2268
2348
|
* @returns {User}
|
|
2269
|
-
|
|
2349
|
+
*/
|
|
2270
2350
|
getSender(): User;
|
|
2271
2351
|
/**
|
|
2272
2352
|
* @param {User} value
|
|
2273
2353
|
* Set sender of the message.
|
|
2274
|
-
|
|
2354
|
+
*/
|
|
2275
2355
|
setSender(value: User): void;
|
|
2276
2356
|
/**
|
|
2277
2357
|
* Get receiver of the message.
|
|
2278
2358
|
* @returns {User | Group}
|
|
2279
|
-
|
|
2359
|
+
*/
|
|
2280
2360
|
getReceiver(): User | Group;
|
|
2281
2361
|
/**
|
|
2282
2362
|
* @param {User | Group} value
|
|
2283
2363
|
* Set receiver of the message.
|
|
2284
|
-
|
|
2364
|
+
*/
|
|
2285
2365
|
setReceiver(value: User | Group): void;
|
|
2286
2366
|
/**
|
|
2287
2367
|
* Get receiverID of the message.
|
|
2288
2368
|
* @returns {string}
|
|
2289
|
-
|
|
2369
|
+
*/
|
|
2290
2370
|
getReceiverId(): string;
|
|
2291
2371
|
/**
|
|
2292
2372
|
* @param {string} value
|
|
2293
2373
|
* Set receiverId of the message.
|
|
2294
|
-
|
|
2374
|
+
*/
|
|
2295
2375
|
setReceiverId(value: string): void;
|
|
2296
2376
|
/**
|
|
2297
2377
|
* Get type of the message.
|
|
2298
2378
|
* @returns {string}
|
|
2299
|
-
|
|
2379
|
+
*/
|
|
2300
2380
|
getType(): string;
|
|
2301
2381
|
/**
|
|
2302
2382
|
* @param {string} value
|
|
2303
2383
|
* Set type of the message.
|
|
2304
|
-
|
|
2384
|
+
*/
|
|
2305
2385
|
setType(value: string): void;
|
|
2306
2386
|
/**
|
|
2307
2387
|
* Get receiver type of the message.
|
|
2308
2388
|
* @returns {string}
|
|
2309
|
-
|
|
2389
|
+
*/
|
|
2310
2390
|
getReceiverType(): string;
|
|
2311
2391
|
/**
|
|
2312
2392
|
* @param {string} value
|
|
2313
2393
|
* Set the receiver type of the message.
|
|
2314
|
-
|
|
2394
|
+
*/
|
|
2315
2395
|
setReceiverType(value: string): void;
|
|
2316
2396
|
/**
|
|
2317
2397
|
* Get message's sentAt timestamp.
|
|
2318
2398
|
* @returns {number}
|
|
2319
|
-
|
|
2399
|
+
*/
|
|
2320
2400
|
getSentAt(): number;
|
|
2321
2401
|
/**
|
|
2322
2402
|
* @param {number} value
|
|
2323
2403
|
* Set message's sentAt timestamp.
|
|
2324
|
-
|
|
2404
|
+
*/
|
|
2325
2405
|
setSentAt(value: number): void;
|
|
2326
2406
|
/** @private */
|
|
2327
2407
|
getStatus(): string;
|
|
@@ -2330,22 +2410,22 @@ export class BaseMessage implements Message {
|
|
|
2330
2410
|
/**
|
|
2331
2411
|
* Get delivery timestamp of the message.
|
|
2332
2412
|
* @returns {number}
|
|
2333
|
-
|
|
2413
|
+
*/
|
|
2334
2414
|
getDeliveredAt(): number;
|
|
2335
2415
|
/**
|
|
2336
2416
|
* @param {number} deliveredAt
|
|
2337
2417
|
* Set delivery timestamp of the message.
|
|
2338
|
-
|
|
2418
|
+
*/
|
|
2339
2419
|
setDeliveredAt(deliveredAt: number): void;
|
|
2340
2420
|
/**
|
|
2341
2421
|
* Get timestamp of the message at which it was delivered to logged in user.
|
|
2342
2422
|
* @returns {number}
|
|
2343
|
-
|
|
2423
|
+
*/
|
|
2344
2424
|
getDeliveredToMeAt(): number;
|
|
2345
2425
|
/**
|
|
2346
2426
|
* @param {number} deliveredToMeAt
|
|
2347
2427
|
* Set timestamp of the message at which it was delivered to logged in user.
|
|
2348
|
-
|
|
2428
|
+
*/
|
|
2349
2429
|
setDeliveredToMeAt(deliveredToMeAt: number): void;
|
|
2350
2430
|
/**
|
|
2351
2431
|
* Get Timestamp of the when message was read at.
|
|
@@ -2355,67 +2435,67 @@ export class BaseMessage implements Message {
|
|
|
2355
2435
|
/**
|
|
2356
2436
|
* @param {number} readAt
|
|
2357
2437
|
* Set read timestamp of the message.
|
|
2358
|
-
|
|
2438
|
+
*/
|
|
2359
2439
|
setReadAt(readAt: number): void;
|
|
2360
2440
|
/**
|
|
2361
2441
|
* Get timestamp of the message at which it was read by the logged in user.
|
|
2362
2442
|
* @returns {number}
|
|
2363
|
-
|
|
2443
|
+
*/
|
|
2364
2444
|
getReadByMeAt(): number;
|
|
2365
2445
|
/**
|
|
2366
2446
|
* @param {number} readByMeAt
|
|
2367
2447
|
* Set timestamp of the message at which it was read by the logged in user.
|
|
2368
|
-
|
|
2448
|
+
*/
|
|
2369
2449
|
setReadByMeAt(readByMeAt: number): void;
|
|
2370
2450
|
/**
|
|
2371
2451
|
* Get category of the message.
|
|
2372
2452
|
* @returns {string}
|
|
2373
|
-
|
|
2453
|
+
*/
|
|
2374
2454
|
getCategory(): MessageCategory;
|
|
2375
2455
|
/**
|
|
2376
2456
|
* @param {string} category
|
|
2377
2457
|
* Set category of the message.
|
|
2378
|
-
|
|
2458
|
+
*/
|
|
2379
2459
|
setCategory(category: MessageCategory): void;
|
|
2380
2460
|
/**
|
|
2381
2461
|
* Get timestamp of the message when it was updated/edited.
|
|
2382
2462
|
* @returns
|
|
2383
|
-
|
|
2463
|
+
*/
|
|
2384
2464
|
getEditedAt(): number;
|
|
2385
2465
|
/**
|
|
2386
2466
|
* @param {number} editedAt
|
|
2387
2467
|
* Set timestamp of the message when it was updated/edited.
|
|
2388
|
-
|
|
2468
|
+
*/
|
|
2389
2469
|
setEditedAt(editedAt: number): void;
|
|
2390
2470
|
/**
|
|
2391
2471
|
* Get UID of the user who edited/updated the message.
|
|
2392
2472
|
* @returns
|
|
2393
|
-
|
|
2473
|
+
*/
|
|
2394
2474
|
getEditedBy(): string;
|
|
2395
2475
|
/**
|
|
2396
2476
|
* @param {string} editedBy
|
|
2397
2477
|
* Set UID of the user who edited/updated the message.
|
|
2398
|
-
|
|
2478
|
+
*/
|
|
2399
2479
|
setEditedBy(editedBy: string): void;
|
|
2400
2480
|
/**
|
|
2401
2481
|
* Get timestamp of the message when it was deleted.
|
|
2402
2482
|
* @returns {number}
|
|
2403
|
-
|
|
2483
|
+
*/
|
|
2404
2484
|
getDeletedAt(): number;
|
|
2405
2485
|
/**
|
|
2406
2486
|
* @param {number} deletedAt
|
|
2407
2487
|
* Set timestamp of the message when it was deleted.
|
|
2408
|
-
|
|
2488
|
+
*/
|
|
2409
2489
|
setDeletedAt(deletedAt: number): void;
|
|
2410
2490
|
/**
|
|
2411
2491
|
* Get UID of the user who deleted the message.
|
|
2412
2492
|
* @returns {number}
|
|
2413
|
-
|
|
2493
|
+
*/
|
|
2414
2494
|
getDeletedBy(): string;
|
|
2415
2495
|
/**
|
|
2416
2496
|
* @param {string} deletedBy
|
|
2417
2497
|
* Set UID of the user who deleted the message.
|
|
2418
|
-
|
|
2498
|
+
*/
|
|
2419
2499
|
setDeletedBy(deletedBy: string): void;
|
|
2420
2500
|
/**
|
|
2421
2501
|
* Get the number of replies of the message.
|
|
@@ -2425,7 +2505,7 @@ export class BaseMessage implements Message {
|
|
|
2425
2505
|
/**
|
|
2426
2506
|
* @param {number} value
|
|
2427
2507
|
* Set the number of replies of the message.
|
|
2428
|
-
|
|
2508
|
+
*/
|
|
2429
2509
|
setReplyCount(value: number): void;
|
|
2430
2510
|
/**
|
|
2431
2511
|
* Get the raw JSON of the message.
|
|
@@ -2435,8 +2515,48 @@ export class BaseMessage implements Message {
|
|
|
2435
2515
|
/**
|
|
2436
2516
|
* @param {Object} rawMessage
|
|
2437
2517
|
* Set the raw JSON of the message.
|
|
2438
|
-
|
|
2518
|
+
*/
|
|
2439
2519
|
setRawMessage(rawMessage: Object): void;
|
|
2520
|
+
/**
|
|
2521
|
+
* @param {User[]} mentionedUsers
|
|
2522
|
+
* Set the array of mentioned users
|
|
2523
|
+
*/
|
|
2524
|
+
setMentionedUsers(mentionedUsers: User[]): void;
|
|
2525
|
+
/**
|
|
2526
|
+
* Get the array of mentioned users
|
|
2527
|
+
* @returns
|
|
2528
|
+
*/
|
|
2529
|
+
getMentionedUsers(): User[];
|
|
2530
|
+
/**
|
|
2531
|
+
* @param {boolean} hasMentionedMe
|
|
2532
|
+
* Method to set if the user was mentioned in the message
|
|
2533
|
+
*/
|
|
2534
|
+
setHasMentionedMe(hasMentionedMe: boolean): void;
|
|
2535
|
+
/**
|
|
2536
|
+
* Method to check if the user was mentioned in the message
|
|
2537
|
+
* @returns
|
|
2538
|
+
*/
|
|
2539
|
+
hasMentionedMe(): boolean;
|
|
2540
|
+
/**
|
|
2541
|
+
* Method to get data of the message.
|
|
2542
|
+
* @returns {Object}
|
|
2543
|
+
*/
|
|
2544
|
+
getData(): any;
|
|
2545
|
+
/**
|
|
2546
|
+
* Method to set data of the message.
|
|
2547
|
+
* @param {Object} value
|
|
2548
|
+
*/
|
|
2549
|
+
setData(value: object): void;
|
|
2550
|
+
/**
|
|
2551
|
+
* set the array of reactions in message
|
|
2552
|
+
* @returns {ReactionCount[]}
|
|
2553
|
+
*/
|
|
2554
|
+
setReactions(reactions: any): ReactionCount[];
|
|
2555
|
+
/**
|
|
2556
|
+
* Get the array of reactions in message
|
|
2557
|
+
* @returns {ReactionCount[]}
|
|
2558
|
+
*/
|
|
2559
|
+
getReactions(): ReactionCount[];
|
|
2440
2560
|
}
|
|
2441
2561
|
|
|
2442
2562
|
/**
|
|
@@ -2451,7 +2571,7 @@ export class TextMessage extends BaseMessage implements Message {
|
|
|
2451
2571
|
};
|
|
2452
2572
|
/** @private */ static readonly CATEGORY: string;
|
|
2453
2573
|
private text?;
|
|
2454
|
-
|
|
2574
|
+
protected data?: any;
|
|
2455
2575
|
private processedText?;
|
|
2456
2576
|
private tags?;
|
|
2457
2577
|
/**
|
|
@@ -2492,7 +2612,7 @@ export class TextMessage extends BaseMessage implements Message {
|
|
|
2492
2612
|
* Method to set data of the message.
|
|
2493
2613
|
* @param {Object} value
|
|
2494
2614
|
*/
|
|
2495
|
-
setData(value:
|
|
2615
|
+
setData(value: any): void;
|
|
2496
2616
|
/**
|
|
2497
2617
|
* Method to get text of the message.
|
|
2498
2618
|
* @returns {string}
|
|
@@ -2527,6 +2647,7 @@ export const constants: {
|
|
|
2527
2647
|
export const DEFAULT_VALUES: {
|
|
2528
2648
|
ZERO: number;
|
|
2529
2649
|
MSGS_LIMIT: number;
|
|
2650
|
+
REACTIONS_LIMIT: number;
|
|
2530
2651
|
MSGS_MAX_LIMIT: number;
|
|
2531
2652
|
USERS_LIMIT: number;
|
|
2532
2653
|
USERS_MAX_LIMIT: number;
|
|
@@ -2608,6 +2729,8 @@ export const ResponseConstants: {
|
|
|
2608
2729
|
KEY_DATA: string;
|
|
2609
2730
|
KEY_META: string;
|
|
2610
2731
|
KEY_CURSOR: string;
|
|
2732
|
+
KEY_NEXT: string;
|
|
2733
|
+
KEY_PREVIOUS: string;
|
|
2611
2734
|
KEY_ACTION: string;
|
|
2612
2735
|
KEY_MESSAGE: string;
|
|
2613
2736
|
KEY_ERROR: string;
|
|
@@ -2619,6 +2742,7 @@ export const ResponseConstants: {
|
|
|
2619
2742
|
KEY_IDENTITY: string;
|
|
2620
2743
|
KEY_SERVICE: string;
|
|
2621
2744
|
KEY_ENTITIES: string;
|
|
2745
|
+
KEY_REACTIONS: string;
|
|
2622
2746
|
KEY_ENTITITY: string;
|
|
2623
2747
|
KEY_ENTITYTYPE: string;
|
|
2624
2748
|
KEY_ATTACHMENTS: string;
|
|
@@ -2682,6 +2806,7 @@ export const MessageConstatnts: {
|
|
|
2682
2806
|
ACTION: string;
|
|
2683
2807
|
CALL: string;
|
|
2684
2808
|
CUSTOM: string;
|
|
2809
|
+
INTERACTIVE: string;
|
|
2685
2810
|
};
|
|
2686
2811
|
RECEIVER_TYPE: {
|
|
2687
2812
|
USER: string;
|
|
@@ -2710,6 +2835,14 @@ export const MessageConstatnts: {
|
|
|
2710
2835
|
CUSTOM_DATA: string;
|
|
2711
2836
|
CUSTOM_SUB_TYPE: string;
|
|
2712
2837
|
RESOURCE: string;
|
|
2838
|
+
MENTIONS: string;
|
|
2839
|
+
INTERACTIVE_DATA: string;
|
|
2840
|
+
INTERACTION_GOAL: string;
|
|
2841
|
+
INTERACTIONS: string;
|
|
2842
|
+
ALLOW_SENDER_INTERACTION: string;
|
|
2843
|
+
ELEMENT_ID: string;
|
|
2844
|
+
INTERACTED_AT: string;
|
|
2845
|
+
ELEMENT_IDS: string;
|
|
2713
2846
|
};
|
|
2714
2847
|
KNOWN_MEDIA_TYPE: {
|
|
2715
2848
|
IMAGE: any[];
|
|
@@ -2751,6 +2884,10 @@ export const MessageConstatnts: {
|
|
|
2751
2884
|
HIDE_DELETED_MESSAGES: string;
|
|
2752
2885
|
WITH_TAGS: string;
|
|
2753
2886
|
TAGS: string;
|
|
2887
|
+
MY_MENTIONS_ONLY: string;
|
|
2888
|
+
MENTIONS_WITH_TAG_INFO: string;
|
|
2889
|
+
MENTIONS_WITH_BLOCKED_INFO: string;
|
|
2890
|
+
ONLY_INTERACTION_GOAL_COMPLETED: string;
|
|
2754
2891
|
};
|
|
2755
2892
|
};
|
|
2756
2893
|
};
|
|
@@ -2767,7 +2904,14 @@ export enum MessageCategory {
|
|
|
2767
2904
|
ACTION = "action",
|
|
2768
2905
|
MESSAGE = "message",
|
|
2769
2906
|
CALL = "call",
|
|
2770
|
-
CUSTOM = "custom"
|
|
2907
|
+
CUSTOM = "custom",
|
|
2908
|
+
INTERACTIVE = "interactive"
|
|
2909
|
+
}
|
|
2910
|
+
export enum GoalType {
|
|
2911
|
+
ANY_ACTION = "anyAction",
|
|
2912
|
+
ANY_OF = "anyOf",
|
|
2913
|
+
ALL_OF = "allOf",
|
|
2914
|
+
NONE = "none"
|
|
2771
2915
|
}
|
|
2772
2916
|
export const TYPING_NOTIFICATION: {
|
|
2773
2917
|
RECEIVER_ID: string;
|
|
@@ -3456,6 +3600,10 @@ export const CONNECTION_STATUS: {
|
|
|
3456
3600
|
export const SESSION_STORE: {
|
|
3457
3601
|
SESSION_ID: string;
|
|
3458
3602
|
};
|
|
3603
|
+
export enum REACTION_ACTION {
|
|
3604
|
+
REACTION_ADDED = "message_reaction_added",
|
|
3605
|
+
REACTION_REMOVED = "message_reaction_removed"
|
|
3606
|
+
}
|
|
3459
3607
|
export const API_ERROR_CODES: {
|
|
3460
3608
|
AUTH_ERR_AUTH_TOKEN_NOT_FOUND: string;
|
|
3461
3609
|
};
|
|
@@ -3625,14 +3773,14 @@ export class Group {
|
|
|
3625
3773
|
setOwner(owner: string): void;
|
|
3626
3774
|
/**
|
|
3627
3775
|
* Method to get metadata of the group.
|
|
3628
|
-
* @returns {
|
|
3776
|
+
* @returns {object}
|
|
3629
3777
|
*/
|
|
3630
|
-
getMetadata():
|
|
3778
|
+
getMetadata(): object;
|
|
3631
3779
|
/**
|
|
3632
3780
|
* Method to set metadata of the group.
|
|
3633
|
-
* @param {
|
|
3781
|
+
* @param {object} metadata
|
|
3634
3782
|
*/
|
|
3635
|
-
setMetadata(metadata:
|
|
3783
|
+
setMetadata(metadata: object): void;
|
|
3636
3784
|
/**
|
|
3637
3785
|
* Method to get the created at timestamp of the group.
|
|
3638
3786
|
* @returns {number}
|
|
@@ -3750,6 +3898,23 @@ export class MessageListener {
|
|
|
3750
3898
|
* This event is triggered when a transient message is received.
|
|
3751
3899
|
*/
|
|
3752
3900
|
onTransientMessageReceived?: Function;
|
|
3901
|
+
/**
|
|
3902
|
+
* This event is triggered when a interactive message is received.
|
|
3903
|
+
*/
|
|
3904
|
+
onInteractiveMessageReceived?: Function;
|
|
3905
|
+
/**
|
|
3906
|
+
* This event is triggered when a interaction goal is completd .
|
|
3907
|
+
*/
|
|
3908
|
+
onInteractionGoalCompleted?: Function;
|
|
3909
|
+
/**
|
|
3910
|
+
* This event is triggered when a reaction is added.
|
|
3911
|
+
*/
|
|
3912
|
+
onMessageReactionAdded?: Function; /**
|
|
3913
|
+
|
|
3914
|
+
/**
|
|
3915
|
+
* This event is triggered when a reaction is removed.
|
|
3916
|
+
*/
|
|
3917
|
+
onMessageReactionRemoved?: Function;
|
|
3753
3918
|
constructor(...args: any[]);
|
|
3754
3919
|
}
|
|
3755
3920
|
export class CallListener {
|
|
@@ -3991,6 +4156,7 @@ export class Call extends BaseMessage implements Message {
|
|
|
3991
4156
|
ACTION: string;
|
|
3992
4157
|
CALL: string;
|
|
3993
4158
|
CUSTOM: string;
|
|
4159
|
+
INTERACTIVE: string;
|
|
3994
4160
|
};
|
|
3995
4161
|
static readonly ACTION_TYPE: {
|
|
3996
4162
|
TYPE_MEMBER_JOINED: string;
|
|
@@ -4059,12 +4225,12 @@ export class Call extends BaseMessage implements Message {
|
|
|
4059
4225
|
* Get JSONObject of data set by developer.
|
|
4060
4226
|
* @returns
|
|
4061
4227
|
*/
|
|
4062
|
-
getMetadata():
|
|
4228
|
+
getMetadata(): object;
|
|
4063
4229
|
/**
|
|
4064
|
-
* @param {
|
|
4230
|
+
* @param {object} metadata
|
|
4065
4231
|
* Set metadata of the call message.
|
|
4066
4232
|
*/
|
|
4067
|
-
setMetadata(metadata:
|
|
4233
|
+
setMetadata(metadata: object): void;
|
|
4068
4234
|
/**
|
|
4069
4235
|
* Get sender of the message.
|
|
4070
4236
|
* @returns {User}
|
|
@@ -4275,6 +4441,7 @@ export class Action extends BaseMessage implements Message {
|
|
|
4275
4441
|
ACTION: string;
|
|
4276
4442
|
CALL: string;
|
|
4277
4443
|
CUSTOM: string;
|
|
4444
|
+
INTERACTIVE: string;
|
|
4278
4445
|
};
|
|
4279
4446
|
static readonly ACTION_TYPE: {
|
|
4280
4447
|
TYPE_MEMBER_JOINED: string;
|
|
@@ -4289,6 +4456,7 @@ export class Action extends BaseMessage implements Message {
|
|
|
4289
4456
|
TYPE_MESSAGE_DELETED: string;
|
|
4290
4457
|
TYPE_MEMBER_ADDED: string;
|
|
4291
4458
|
};
|
|
4459
|
+
protected data?: any;
|
|
4292
4460
|
protected actionBy: User | Group | BaseMessage;
|
|
4293
4461
|
protected actionFor: User | Group | BaseMessage;
|
|
4294
4462
|
protected actionOn: User | Group | BaseMessage;
|
|
@@ -4388,14 +4556,14 @@ export class Action extends BaseMessage implements Message {
|
|
|
4388
4556
|
setActionFor(actionFor: User | Group | BaseMessage): void;
|
|
4389
4557
|
/**
|
|
4390
4558
|
* Method to get the metadata of the action message.
|
|
4391
|
-
* @returns {
|
|
4559
|
+
* @returns {object}
|
|
4392
4560
|
*/
|
|
4393
|
-
getMetadata():
|
|
4561
|
+
getMetadata(): object;
|
|
4394
4562
|
/**
|
|
4395
|
-
* @param {
|
|
4563
|
+
* @param {object} metadata
|
|
4396
4564
|
* Method to get the metadata of the action message.
|
|
4397
4565
|
*/
|
|
4398
|
-
setMetadata(metadata:
|
|
4566
|
+
setMetadata(metadata: object): void;
|
|
4399
4567
|
}
|
|
4400
4568
|
|
|
4401
4569
|
export class GroupsRequest {
|
|
@@ -4777,6 +4945,10 @@ export class MessagesRequestBuilder {
|
|
|
4777
4945
|
/** @private */ HideDeletedMessages?: boolean;
|
|
4778
4946
|
/** @private */ tags?: Array<String>;
|
|
4779
4947
|
/** @private */ WithTags?: boolean;
|
|
4948
|
+
/** @private */ interactionGoalCompletedOnly?: boolean;
|
|
4949
|
+
/** @private */ ListMentionedMessages?: boolean;
|
|
4950
|
+
/** @private */ mentionsWithUserTags?: boolean;
|
|
4951
|
+
/** @private */ mentionsWithBlockedRelation?: boolean;
|
|
4780
4952
|
/**
|
|
4781
4953
|
* 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.
|
|
4782
4954
|
* @param {number} limit
|
|
@@ -4891,6 +5063,30 @@ export class MessagesRequestBuilder {
|
|
|
4891
5063
|
* @returns
|
|
4892
5064
|
*/
|
|
4893
5065
|
withTags(withTags: boolean): this;
|
|
5066
|
+
/**
|
|
5067
|
+
* A method to get the list of message with mentions
|
|
5068
|
+
* @param {boolean} listMentionedMessages
|
|
5069
|
+
* @returns
|
|
5070
|
+
*/
|
|
5071
|
+
myMentionsOnly(listMentionedMessages?: boolean): this;
|
|
5072
|
+
/**
|
|
5073
|
+
* A method to include the user tags when getting the list of message with mentions
|
|
5074
|
+
* @param {boolean} mentionsWithUserTags
|
|
5075
|
+
* @returns
|
|
5076
|
+
*/
|
|
5077
|
+
mentionsWithTagInfo(mentionsWithUserTags?: boolean): this;
|
|
5078
|
+
/**
|
|
5079
|
+
* A method to include the blocked relation when getting the list of message with mentions
|
|
5080
|
+
* @param {boolean} mentionsWithBlockedRelation
|
|
5081
|
+
* @returns
|
|
5082
|
+
*/
|
|
5083
|
+
mentionsWithBlockedInfo(mentionsWithBlockedRelation?: boolean): this;
|
|
5084
|
+
/**
|
|
5085
|
+
* A method to get only interacted messages.
|
|
5086
|
+
* @param {boolean} interactionGoalCompletedOnly
|
|
5087
|
+
* @returns
|
|
5088
|
+
*/
|
|
5089
|
+
setInteractionGoalCompletedOnly(interactionGoalCompletedOnly?: boolean): this;
|
|
4894
5090
|
/**
|
|
4895
5091
|
* This method will return an object of the MessagesRequest class.
|
|
4896
5092
|
* @returns {MessagesRequest}
|
|
@@ -4926,14 +5122,14 @@ export class TypingIndicator {
|
|
|
4926
5122
|
setReceiverId(receiverId: string): void;
|
|
4927
5123
|
/**
|
|
4928
5124
|
* Method to get metadata of the transient message.
|
|
4929
|
-
* @returns {
|
|
5125
|
+
* @returns {object}
|
|
4930
5126
|
*/
|
|
4931
|
-
getMetadata():
|
|
5127
|
+
getMetadata(): object;
|
|
4932
5128
|
/**
|
|
4933
5129
|
* Method to set metadata of the transient message.
|
|
4934
|
-
* @param {
|
|
5130
|
+
* @param {object} meta
|
|
4935
5131
|
*/
|
|
4936
|
-
setMetadata(meta:
|
|
5132
|
+
setMetadata(meta: object): void;
|
|
4937
5133
|
/**
|
|
4938
5134
|
* Method to get sender of the transient message.
|
|
4939
5135
|
* @returns {User}
|
|
@@ -4951,6 +5147,7 @@ export class TypingIndicator {
|
|
|
4951
5147
|
* @module CustomMessage
|
|
4952
5148
|
*/
|
|
4953
5149
|
export class CustomMessage extends BaseMessage implements Message {
|
|
5150
|
+
protected data?: Object;
|
|
4954
5151
|
constructor(...args: any[]);
|
|
4955
5152
|
/**
|
|
4956
5153
|
* Method to get custom data of the message.
|
|
@@ -5245,20 +5442,21 @@ export class CometChatHelper {
|
|
|
5245
5442
|
/**
|
|
5246
5443
|
* Takes JSONMessage as an input and will return an Object of BaseMessage Class.
|
|
5247
5444
|
* @param {Object} message
|
|
5248
|
-
* @returns {TextMessage | MediaMessage | CustomMessage | BaseMessage}
|
|
5445
|
+
* @returns {TextMessage | MediaMessage | CustomMessage | InteractiveMessage | BaseMessage}
|
|
5249
5446
|
* @memberof CometChatHelper
|
|
5250
5447
|
*/
|
|
5251
|
-
static processMessage(message: Object): Promise<TextMessage | MediaMessage | CustomMessage | BaseMessage>;
|
|
5448
|
+
static processMessage(message: Object): Promise<TextMessage | MediaMessage | CustomMessage | InteractiveMessage | BaseMessage>;
|
|
5252
5449
|
/**-------------------------------------------------------------------*
|
|
5253
5450
|
* Message related functions provided by CometChat class *
|
|
5254
5451
|
*--------------------------------------------------------------------**/
|
|
5255
5452
|
/**
|
|
5256
5453
|
* Takes a Message Object and converts it into Conversation Object.
|
|
5257
|
-
* @param {TextMessage | MediaMessage | CustomMessage} message
|
|
5454
|
+
* @param {TextMessage | MediaMessage | CustomMessage | InteractiveMessage} message
|
|
5258
5455
|
* @returns {Conversation} conversation
|
|
5259
5456
|
* @memberof CometChat
|
|
5260
5457
|
*/
|
|
5261
|
-
static getConversationFromMessage(message: TextMessage | MediaMessage | CustomMessage | any): Promise<Conversation>;
|
|
5458
|
+
static getConversationFromMessage(message: TextMessage | MediaMessage | CustomMessage | InteractiveMessage | any): Promise<Conversation>;
|
|
5459
|
+
static updateMessageWithReactionInfo(baseMessage: BaseMessage, messageReaction: MessageReaction, action: REACTION_ACTION): Promise<BaseMessage | null>;
|
|
5262
5460
|
}
|
|
5263
5461
|
|
|
5264
5462
|
/**
|
|
@@ -5271,13 +5469,35 @@ export class Conversation {
|
|
|
5271
5469
|
protected lastMessage: TextMessage | MediaMessage | CustomMessage | any;
|
|
5272
5470
|
protected conversationWith: User | Group;
|
|
5273
5471
|
protected unreadMessageCount: number;
|
|
5472
|
+
protected unreadMentionsCount: number;
|
|
5473
|
+
protected lastReadMessageId: string;
|
|
5274
5474
|
protected tags: Array<String>;
|
|
5275
|
-
constructor(conversationId: string, conversationType: string, lastMessage: TextMessage | MediaMessage | CustomMessage | any, conversationWith: User | Group, unreadMessageCount: number, tags: Array<String
|
|
5475
|
+
constructor(conversationId: string, conversationType: string, lastMessage: TextMessage | MediaMessage | CustomMessage | any, conversationWith: User | Group, unreadMessageCount: number, tags: Array<String>, unreadMentionsCount: number | any, lastReadMessageId: string | any);
|
|
5276
5476
|
/**
|
|
5277
5477
|
* Method to set conversation ID of the conversation.
|
|
5278
5478
|
* @param {string} conversationId
|
|
5279
5479
|
*/
|
|
5280
5480
|
setConversationId(conversationId: string): void;
|
|
5481
|
+
/**
|
|
5482
|
+
* Method to get unreadMentionsCount of the conversation.
|
|
5483
|
+
* @returns {number}
|
|
5484
|
+
*/
|
|
5485
|
+
getUnreadMentionsCount(): number;
|
|
5486
|
+
/**
|
|
5487
|
+
* Method to set unreadMentionsCount of the conversation.
|
|
5488
|
+
* @param {number}
|
|
5489
|
+
*/
|
|
5490
|
+
setUnreadMentionsCount(count: number): void;
|
|
5491
|
+
/**
|
|
5492
|
+
* Method to get lastReadMessageId of the conversation.
|
|
5493
|
+
* @returns {string}
|
|
5494
|
+
*/
|
|
5495
|
+
getLastReadMessageId(): string;
|
|
5496
|
+
/**
|
|
5497
|
+
* Method to set lastReadMessageId of the conversation.
|
|
5498
|
+
* @param {string}
|
|
5499
|
+
*/
|
|
5500
|
+
setLastReadMessageId(id: string): void;
|
|
5281
5501
|
/**
|
|
5282
5502
|
* Method to set conversation type of the conversation.
|
|
5283
5503
|
* @param {string} conversationId
|
|
@@ -5843,6 +6063,7 @@ export class MediaDevice {
|
|
|
5843
6063
|
}
|
|
5844
6064
|
|
|
5845
6065
|
export class TransientMessage {
|
|
6066
|
+
protected data: any;
|
|
5846
6067
|
constructor(receiverId: string, receiverType: string, data: any);
|
|
5847
6068
|
/**
|
|
5848
6069
|
* Method to get receiverID of the transient message.
|
|
@@ -5886,6 +6107,266 @@ export class TransientMessage {
|
|
|
5886
6107
|
setSender(sender: User): void;
|
|
5887
6108
|
}
|
|
5888
6109
|
|
|
6110
|
+
/**
|
|
6111
|
+
*
|
|
6112
|
+
* @module InteractiveMessage
|
|
6113
|
+
*/
|
|
6114
|
+
export class InteractiveMessage extends BaseMessage implements Message {
|
|
6115
|
+
/** @private */ static readonly TYPE: {
|
|
6116
|
+
TEXT: string;
|
|
6117
|
+
MEDIA: string;
|
|
6118
|
+
IMAGE: string;
|
|
6119
|
+
VIDEO: string;
|
|
6120
|
+
AUDIO: string;
|
|
6121
|
+
FILE: string;
|
|
6122
|
+
CUSTOM: string;
|
|
6123
|
+
};
|
|
6124
|
+
/** @private */ static readonly RECEIVER_TYPE: {
|
|
6125
|
+
USER: string;
|
|
6126
|
+
GROUP: string;
|
|
6127
|
+
};
|
|
6128
|
+
/** @private */ static readonly CATEGORY: {
|
|
6129
|
+
MESSAGE: string;
|
|
6130
|
+
ACTION: string;
|
|
6131
|
+
CALL: string;
|
|
6132
|
+
CUSTOM: string;
|
|
6133
|
+
INTERACTIVE: string;
|
|
6134
|
+
};
|
|
6135
|
+
private interactiveData;
|
|
6136
|
+
private interactionGoal;
|
|
6137
|
+
protected data?: Object;
|
|
6138
|
+
private interactions?;
|
|
6139
|
+
private tags?;
|
|
6140
|
+
private allowSenderInteraction?;
|
|
6141
|
+
constructor(...args: any[]);
|
|
6142
|
+
/**
|
|
6143
|
+
* Method to get sender of the message.
|
|
6144
|
+
* @returns {User}
|
|
6145
|
+
*/
|
|
6146
|
+
getSender(): User;
|
|
6147
|
+
/**
|
|
6148
|
+
* Method to get interactive data of the message.
|
|
6149
|
+
* @returns {Object}
|
|
6150
|
+
*/
|
|
6151
|
+
getInteractiveData(): Object;
|
|
6152
|
+
/**
|
|
6153
|
+
* Method to set interactive data of interactive message.
|
|
6154
|
+
* @param {Object} interactiveData
|
|
6155
|
+
*/
|
|
6156
|
+
setInteractiveData(interactiveData: Object): void;
|
|
6157
|
+
/**
|
|
6158
|
+
* Method to get receiver of the message.
|
|
6159
|
+
* @returns {User|Group}
|
|
6160
|
+
*/
|
|
6161
|
+
getReceiver(): User | Group;
|
|
6162
|
+
/**
|
|
6163
|
+
* Method to interaction goal of the message.
|
|
6164
|
+
* @returns {InteractionGoal}
|
|
6165
|
+
*/
|
|
6166
|
+
getInteractionGoal(): InteractionGoal;
|
|
6167
|
+
/**
|
|
6168
|
+
* Method to set interaction goal of interactive message.
|
|
6169
|
+
* @param {InteractionGoal} interactionGoal
|
|
6170
|
+
*/
|
|
6171
|
+
setInteractionGoal(interactionGoal: InteractionGoal): void;
|
|
6172
|
+
/**
|
|
6173
|
+
* Method to get interactions on the message.
|
|
6174
|
+
* @returns {Array<Interaction>}
|
|
6175
|
+
*/
|
|
6176
|
+
getInteractions(): Array<Interaction>;
|
|
6177
|
+
/**
|
|
6178
|
+
* Method to set interactions of interactive message.
|
|
6179
|
+
* @param {Array<Interaction>} interactions
|
|
6180
|
+
*/
|
|
6181
|
+
setInteractions(interactions: Array<Interaction>): void;
|
|
6182
|
+
/**
|
|
6183
|
+
* Method to get metadata of the message.
|
|
6184
|
+
* @returns {Object}
|
|
6185
|
+
*/
|
|
6186
|
+
getMetadata(): Object;
|
|
6187
|
+
/**
|
|
6188
|
+
* Method to set sender metadata of the message.
|
|
6189
|
+
* @returns {User}
|
|
6190
|
+
*/
|
|
6191
|
+
setMetadata(metadata: Object): void;
|
|
6192
|
+
/**
|
|
6193
|
+
* Method to get data of the message.
|
|
6194
|
+
* @returns {any}
|
|
6195
|
+
*/
|
|
6196
|
+
getData(): any;
|
|
6197
|
+
/**
|
|
6198
|
+
* Method to get tags of the message.
|
|
6199
|
+
* @returns {Array<String>}
|
|
6200
|
+
*/
|
|
6201
|
+
getTags(): Array<String>;
|
|
6202
|
+
/**
|
|
6203
|
+
* Get the set tags fo the message .
|
|
6204
|
+
* @returns {Array<String>}
|
|
6205
|
+
*/
|
|
6206
|
+
setTags(tags: Array<String>): void;
|
|
6207
|
+
/**
|
|
6208
|
+
* @param {boolean} flag
|
|
6209
|
+
* Set the flag if sender is allowed to interact with the with the message.
|
|
6210
|
+
*/
|
|
6211
|
+
setIsSenderInteractionAllowed(flag: boolean): void;
|
|
6212
|
+
/**
|
|
6213
|
+
* Get the flag which signifies if sender interaction is allowed .
|
|
6214
|
+
* @returns {boolean}
|
|
6215
|
+
*/
|
|
6216
|
+
getIsSenderInteractionAllowed(flag: boolean): boolean;
|
|
6217
|
+
}
|
|
6218
|
+
|
|
6219
|
+
/**
|
|
6220
|
+
*
|
|
6221
|
+
* @module InteractionGoal
|
|
6222
|
+
*/
|
|
6223
|
+
export class InteractionGoal {
|
|
6224
|
+
constructor(type: GoalType, elementIds: Array<String>);
|
|
6225
|
+
/**
|
|
6226
|
+
* Get the type of the interaction goal.
|
|
6227
|
+
* @returns {GoalType}
|
|
6228
|
+
*/
|
|
6229
|
+
getType(): GoalType;
|
|
6230
|
+
/**
|
|
6231
|
+
* @param {GoalType} type
|
|
6232
|
+
* Set the type of goal for the message.
|
|
6233
|
+
*/
|
|
6234
|
+
setType(type: GoalType): void;
|
|
6235
|
+
/**
|
|
6236
|
+
* Get the element ids of the interacttion goal.
|
|
6237
|
+
* @returns {Array<String>}
|
|
6238
|
+
*/
|
|
6239
|
+
getElementIds(): Array<String>;
|
|
6240
|
+
/**
|
|
6241
|
+
* @param {Array<String>} elementIds
|
|
6242
|
+
* Set the element id for the intearction goal.
|
|
6243
|
+
*/
|
|
6244
|
+
setElementIds(elementIds: Array<String>): void;
|
|
6245
|
+
}
|
|
6246
|
+
|
|
6247
|
+
export class Interaction {
|
|
6248
|
+
constructor(elementId: string, interactedAt: number);
|
|
6249
|
+
/**
|
|
6250
|
+
* Get the element id of the interaction.
|
|
6251
|
+
* @returns {string}
|
|
6252
|
+
*/
|
|
6253
|
+
getElementId(): string;
|
|
6254
|
+
/**
|
|
6255
|
+
* Get the time of the interaction.
|
|
6256
|
+
* @returns {number}
|
|
6257
|
+
*/
|
|
6258
|
+
getInteractedAt(): number;
|
|
6259
|
+
/**
|
|
6260
|
+
* @param {string} elementId
|
|
6261
|
+
* Set the element id.
|
|
6262
|
+
*/
|
|
6263
|
+
setElementId(elementId: string): void;
|
|
6264
|
+
/**
|
|
6265
|
+
* @param {number} interactedAt
|
|
6266
|
+
* Set the time of intertaction .
|
|
6267
|
+
*/
|
|
6268
|
+
setInteractedAt(interactedAt: number): void;
|
|
6269
|
+
static getInteractionFromJSON(message: any): Interaction;
|
|
6270
|
+
}
|
|
6271
|
+
|
|
6272
|
+
/**
|
|
6273
|
+
*
|
|
6274
|
+
* @module InteractionReceipt
|
|
6275
|
+
*/
|
|
6276
|
+
export class InteractionReceipt {
|
|
6277
|
+
/**
|
|
6278
|
+
* Method to get receiver type of the interaction receipt.
|
|
6279
|
+
* @returns {string}
|
|
6280
|
+
*/
|
|
6281
|
+
getReceiverType(): string;
|
|
6282
|
+
/**
|
|
6283
|
+
* Method to set receiver type of the interaction receipt.
|
|
6284
|
+
* @param {string} receiverType
|
|
6285
|
+
*/
|
|
6286
|
+
setReceiverType(receiverType: string): void;
|
|
6287
|
+
/**
|
|
6288
|
+
* Method to get sender of the interaction receipt.
|
|
6289
|
+
* @returns {User}
|
|
6290
|
+
*/
|
|
6291
|
+
getSender(): User;
|
|
6292
|
+
/**
|
|
6293
|
+
* Method to set sender of the interaction receipt.
|
|
6294
|
+
* @param {User} sender
|
|
6295
|
+
*/
|
|
6296
|
+
setSender(sender: User): void;
|
|
6297
|
+
/**
|
|
6298
|
+
* Method to get receiver id of the interaction receipt.
|
|
6299
|
+
* @returns {string}
|
|
6300
|
+
*/
|
|
6301
|
+
getReceiveId(): string;
|
|
6302
|
+
/**
|
|
6303
|
+
* Method to set receiver of the interaction receipt.
|
|
6304
|
+
* @param {string} receiverId
|
|
6305
|
+
*/
|
|
6306
|
+
setReceiverId(receiverId: string): void;
|
|
6307
|
+
/**
|
|
6308
|
+
* Method to get the message ID.
|
|
6309
|
+
* @returns {string}
|
|
6310
|
+
*/
|
|
6311
|
+
getMessageId(): string;
|
|
6312
|
+
/**
|
|
6313
|
+
* Method to set the message ID.
|
|
6314
|
+
* @param {string} messageId
|
|
6315
|
+
*/
|
|
6316
|
+
setMessageId(messageId: string): void;
|
|
6317
|
+
/**
|
|
6318
|
+
* Method to get the interactions.
|
|
6319
|
+
* @returns { Array<Interaction>}
|
|
6320
|
+
*/
|
|
6321
|
+
getInteractions(): Array<Interaction>;
|
|
6322
|
+
/**
|
|
6323
|
+
* Method to set the interactions.
|
|
6324
|
+
* @param {Array<Interaction>} interactions
|
|
6325
|
+
*/
|
|
6326
|
+
setInteractions(interactions: Array<Interaction>): void;
|
|
6327
|
+
}
|
|
6328
|
+
|
|
6329
|
+
export class ReactionRequest {
|
|
6330
|
+
constructor(builder?: ReactionRequestBuilder);
|
|
6331
|
+
/**
|
|
6332
|
+
* Get list of next reactions list based on the parameters specified in ReactionRequestBuilder class. The Developer need to call this method repeatedly using the same object of ReactionRequest class to get paginated list of reactions.
|
|
6333
|
+
* @returns {Promise<MessageReaction[] | []>}
|
|
6334
|
+
*/
|
|
6335
|
+
fetchNext(): Promise<MessageReaction[] | []>;
|
|
6336
|
+
/**
|
|
6337
|
+
* Get list of previous reactions list based on the parameters specified in ReactionRequestBuilder class. The Developer need to call this method repeatedly using the same object of ReactionRequest class to get paginated list of reactions.
|
|
6338
|
+
* @returns {Promise<MessageReaction[] | []>}
|
|
6339
|
+
*/
|
|
6340
|
+
fetchPrevious(): Promise<MessageReaction[] | []>;
|
|
6341
|
+
}
|
|
6342
|
+
export class ReactionRequestBuilder {
|
|
6343
|
+
/** @private */ limit?: number;
|
|
6344
|
+
/** @private */ msgId: number;
|
|
6345
|
+
/** @private */ reaction?: string;
|
|
6346
|
+
/**
|
|
6347
|
+
* A method to set limit for the number of entries returned in a single iteration. A maximum of 100 entries can fetched in a single iteration.
|
|
6348
|
+
* @param {number} limit
|
|
6349
|
+
* @returns
|
|
6350
|
+
*/
|
|
6351
|
+
setLimit(limit: number): this;
|
|
6352
|
+
/**
|
|
6353
|
+
* A method to set message ID for which reactions needed to fetch.
|
|
6354
|
+
* @param {number} id
|
|
6355
|
+
* @returns
|
|
6356
|
+
*/
|
|
6357
|
+
setMessageId(id?: number): this;
|
|
6358
|
+
/**
|
|
6359
|
+
* A method to fetch list of MessageReaction for a specific reaction.
|
|
6360
|
+
* @returns
|
|
6361
|
+
*/
|
|
6362
|
+
setReaction(reaction: string): this;
|
|
6363
|
+
/**
|
|
6364
|
+
* This method will return an object of the ReactionRequest class.
|
|
6365
|
+
* @returns {ReactionRequest}
|
|
6366
|
+
*/
|
|
6367
|
+
build(): ReactionRequest;
|
|
6368
|
+
}
|
|
6369
|
+
|
|
5889
6370
|
/**
|
|
5890
6371
|
*
|
|
5891
6372
|
*
|
|
@@ -5990,6 +6471,55 @@ export class MessageReceipt {
|
|
|
5990
6471
|
setReceiptType(receiptType?: string): void;
|
|
5991
6472
|
}
|
|
5992
6473
|
|
|
6474
|
+
export class ReactionCount {
|
|
6475
|
+
reaction: string;
|
|
6476
|
+
count: number;
|
|
6477
|
+
reactedByMe?: boolean;
|
|
6478
|
+
constructor(object: any);
|
|
6479
|
+
/**
|
|
6480
|
+
* Method to get reacted reaction.
|
|
6481
|
+
* @returns {string}
|
|
6482
|
+
*/
|
|
6483
|
+
getReaction(): string;
|
|
6484
|
+
/**
|
|
6485
|
+
* Method to set reacted reaction.
|
|
6486
|
+
*/
|
|
6487
|
+
setReaction(reaction: string): void;
|
|
6488
|
+
/**
|
|
6489
|
+
* Method to get no of users reacted with a reaction.
|
|
6490
|
+
* @returns {number}
|
|
6491
|
+
*/
|
|
6492
|
+
getCount(): number;
|
|
6493
|
+
/**
|
|
6494
|
+
* Method to set no of users reacted with a reaction.
|
|
6495
|
+
*/
|
|
6496
|
+
setCount(count: number): void;
|
|
6497
|
+
/**
|
|
6498
|
+
* Method to get if loggedIn user reacted with the a reaction.
|
|
6499
|
+
* @returns {boolean}
|
|
6500
|
+
*/
|
|
6501
|
+
getReactedByMe(): boolean;
|
|
6502
|
+
/**
|
|
6503
|
+
* Method to set if loggedIn user reacted with the a reaction.
|
|
6504
|
+
*/
|
|
6505
|
+
setReactedByMe(reactedByMe: boolean): void;
|
|
6506
|
+
}
|
|
6507
|
+
export class MessageReaction {
|
|
6508
|
+
constructor(object: any);
|
|
6509
|
+
getReactionId(): string;
|
|
6510
|
+
setReactionId(id: string): void;
|
|
6511
|
+
getMessageId(): number | string;
|
|
6512
|
+
setMessageId(messageId: number | string): void;
|
|
6513
|
+
getReaction(): string;
|
|
6514
|
+
setReaction(reaction: string): void;
|
|
6515
|
+
getUid(): string;
|
|
6516
|
+
setUid(uid: string): void;
|
|
6517
|
+
getReactedAt(): number;
|
|
6518
|
+
setReactedAt(reactedAt: number): void;
|
|
6519
|
+
getReactedBy(): User;
|
|
6520
|
+
setReactedBy(reactedBy: User): void;
|
|
6521
|
+
}
|
|
6522
|
+
|
|
5993
6523
|
export class RTCUser {
|
|
5994
6524
|
constructor(uid: string);
|
|
5995
6525
|
setUID(uid: string): void;
|