1
1
/**
2
- * Type Definitions for SendBird SDK v3.0.122
2
+ * Type Definitions for SendBird SDK v3.0.123
3
3
* homepage: https://sendbird.com/
4
4
* git: https://github.com/sendbird/SendBird-SDK-JavaScript
5
5
*/
@@ -40,6 +40,12 @@ declare namespace SendBird {
40
40
} ;
41
41
type getGroupChannelChangeLogsHandler = ( data : groupChannelChangeLogs , error : SendBirdError ) => void ;
42
42
43
+ type getEmojiContainerHandler = ( data : EmojiContainer , error : SendBirdError ) => void ;
44
+
45
+ type getEmojiCategoryHandler = ( data : EmojiCategory , error : SendBirdError ) => void ;
46
+
47
+ type getEmojiHandler = ( data : Emoji , error : SendBirdError ) => void ;
48
+
43
49
type pushTokens = {
44
50
deviceTokens : Array < string > ;
45
51
type : 'gcm' | 'apns' | 'apns_voip' ;
@@ -218,6 +224,14 @@ declare namespace SendBird {
218
224
includeEmpty : boolean ,
219
225
callback : getGroupChannelChangeLogsHandler
220
226
) : void ;
227
+
228
+ getAllEmoji ( callback : getEmojiContainerHandler ) : void ;
229
+ getEmojiCategory ( categoryId : number , callback : getEmojiCategoryHandler ) : void ;
230
+ getEmoji ( emojiKey : string , callback : getEmojiHandler ) : void ;
231
+
232
+ getAllEmoji ( ) : Promise < EmojiContainer > ;
233
+ getEmojiCategory ( categoryId : number ) : Promise < EmojiCategory > ;
234
+ getEmoji ( emojiKey : string ) : Promise < Emoji > ;
221
235
}
222
236
223
237
interface Options {
@@ -288,6 +302,7 @@ declare namespace SendBird {
288
302
onChannelHidden ( channel : GroupChannel ) : void ;
289
303
onReactionUpdated ( channel : OpenChannel | GroupChannel , reactionEvent : ReactionEvent ) : void ;
290
304
onMentionReceived ( channel : OpenChannel | GroupChannel , message : AdminMessage | UserMessage | FileMessage ) : void ;
305
+ onThreadInfoUpdated ( channel : OpenChannel | GroupChannel , threadInfoUpdateEvent : ThreadInfoUpdateEvent ) : void ;
291
306
}
292
307
293
308
interface ConnectionHandlerStatic {
@@ -315,6 +330,9 @@ declare namespace SendBird {
315
330
mentionedUsers : Array < User > ;
316
331
createdAt : number ;
317
332
updatedAt : number ;
333
+ parentMessageId : number ;
334
+ parentMessageText : string ;
335
+ threadInfo : ThreadInfo ;
318
336
319
337
isEqual ( target : BaseMessageInstance ) : boolean ;
320
338
isIdentical ( target : BaseMessageInstance ) : boolean ;
@@ -326,6 +344,8 @@ declare namespace SendBird {
326
344
serialize ( ) : Object ;
327
345
getMetaArraysByKeys ( keys : Array < string > ) : Array < MessageMetaArray > ;
328
346
applyReactionEvent ( event : ReactionEvent ) : void ;
347
+ getThreadedMessagesByTimestamp ( timestamp : number , params : ThreadedMessageListParams , callback : threadedMessageListCallback ) : void ;
348
+ applyThreadInfoUpdateEvent ( threadInfoUpdateEvent : ThreadInfoUpdateEvent ) : boolean ;
329
349
330
350
metaArray : Object ; // DEPRECATED
331
351
getMetaArrayByKeys ( keys : Array < string > ) : Object ; // DEPRECATED
@@ -338,6 +358,7 @@ declare namespace SendBird {
338
358
}
339
359
interface AdminMessageStatic {
340
360
buildFromSerializedData ( serializedObject : Object ) : AdminMessage ;
361
+ getMessage ( params : MessageRetrievalParams , callback : messageCallback ) : void ;
341
362
}
342
363
343
364
interface GroupChannelTotalUnreadMessageCountParams {
@@ -346,6 +367,23 @@ declare namespace SendBird {
346
367
superChannelFilter : 'all' | 'super' | 'nonsuper' ;
347
368
}
348
369
370
+ interface Emoji {
371
+ key : string ;
372
+ url : string ;
373
+ }
374
+
375
+ interface EmojiCategory {
376
+ id : number ;
377
+ name : string ;
378
+ url : string ;
379
+ emojis : Array < Emoji > ;
380
+ }
381
+
382
+ interface EmojiContainer {
383
+ emojiHash : string ;
384
+ emojiCategories : Array < EmojiCategory > ;
385
+ }
386
+
349
387
interface UserMessageParams {
350
388
new ( ) : UserMessageParams ;
351
389
message : string ;
@@ -359,6 +397,7 @@ declare namespace SendBird {
359
397
metaArrays : Array < MessageMetaArray > ;
360
398
metaArrayKeys : Array < string > ; // DEPRECATED
361
399
pushNotificationDeliveryOption : 'default' | 'suppress' ;
400
+ parentMessageId : number ;
362
401
}
363
402
interface UserMessage extends BaseMessageInstance {
364
403
messageType : 'user' ;
@@ -375,6 +414,7 @@ declare namespace SendBird {
375
414
}
376
415
interface UserMessageStatic {
377
416
buildFromSerializedData ( serializedObject : Object ) : UserMessage ;
417
+ getMessage ( params : MessageRetrievalParams , callback : messageCallback ) : void ;
378
418
}
379
419
380
420
interface FileMessageParams {
@@ -393,6 +433,7 @@ declare namespace SendBird {
393
433
metaArrays : Array < MessageMetaArray > ;
394
434
metaArrayKeys : Array < string > ; // DEPRECATED
395
435
pushNotificationDeliveryOption : 'default' | 'suppress' ;
436
+ parentMessageId : number ;
396
437
}
397
438
interface FileMessage extends BaseMessageInstance {
398
439
messageType : 'file' ;
@@ -412,6 +453,53 @@ declare namespace SendBird {
412
453
}
413
454
interface FileMessageStatic {
414
455
buildFromSerializedData ( serializedObject : Object ) : FileMessage ;
456
+ getMessage ( params : MessageRetrievalParams , callback : messageCallback ) : void ;
457
+ }
458
+
459
+ interface MessageRetrievalParams {
460
+ new ( ) : MessageRetrievalParams ;
461
+ channelUrl : string ;
462
+ channelType : string ;
463
+ messageId : number ;
464
+ includeMetaArray : boolean ;
465
+ includeParentMessageText : boolean ;
466
+ includeThreadInfo : boolean ;
467
+ }
468
+ interface MessageListParams {
469
+ new ( ) : MessageListParams ;
470
+ prevResultSize : number ;
471
+ nextResultSize : number ;
472
+ isInclusive : boolean ;
473
+ shouldReverse : boolean ;
474
+ messageType : string ;
475
+ customType : string ;
476
+ senderUserIds : Array < string > ;
477
+ includeMetaArray : boolean ;
478
+ includeReactions : boolean ;
479
+ includeReplies : boolean ;
480
+ includeParentMessageText : boolean ;
481
+ includeThreadInfo : boolean ;
482
+ }
483
+ interface ThreadedMessageListParams {
484
+ new ( ) : ThreadedMessageListParams ;
485
+ prevResultSize : number ;
486
+ nextResultSize : number ;
487
+ isInclusive : boolean ;
488
+ shouldReverse : boolean ;
489
+ messageType : string ;
490
+ customType : string ;
491
+ senderUserIds : Array < string > ;
492
+ includeMetaArray : boolean ;
493
+ includeReactions : boolean ;
494
+ includeParentMessageText : boolean ;
495
+ }
496
+ interface MessageChangeLogsParams {
497
+ new ( ) : MessageChangeLogsParams ;
498
+ includeMetaArray : boolean ;
499
+ includeReactions : boolean ;
500
+ includeReplies : boolean ;
501
+ includeParentMessageText : string ;
502
+ includeThreadInfo : boolean ;
415
503
}
416
504
417
505
interface ThumbnailObject {
@@ -512,6 +600,7 @@ declare namespace SendBird {
512
600
isOpenChannel ( ) : boolean ;
513
601
serialize ( ) : Object ;
514
602
603
+ /* DEPRECATED */
515
604
getMessageChangeLogsByToken ( callback : getMessageChangeLogsHandler ) : void ;
516
605
getMessageChangeLogsByToken ( token : string , callback : getMessageChangeLogsHandler ) : void ;
517
606
getMessageChangeLogsByToken ( token : string , includeMetaArray : boolean , callback : getMessageChangeLogsHandler ) : void ;
@@ -522,6 +611,7 @@ declare namespace SendBird {
522
611
callback : getMessageChangeLogsHandler
523
612
) : void ;
524
613
614
+ /* DEPRECATED */
525
615
getMessageChangeLogsByTimestamp ( ts : number , callback : getMessageChangeLogsHandler ) : void ;
526
616
getMessageChangeLogsByTimestamp ( ts : number , includeMetaArray : boolean , callback : getMessageChangeLogsHandler ) : void ;
527
617
getMessageChangeLogsByTimestamp (
@@ -531,12 +621,17 @@ declare namespace SendBird {
531
621
callback : getMessageChangeLogsHandler
532
622
) : void ;
533
623
624
+ getMessageChangeLogsSinceToken ( token : string , params : MessageChangeLogsParams , callback : getMessageChangeLogsHandler ) : void ;
625
+ getMessageChangeLogsSinceTimestamp ( timestamp : number , params : MessageChangeLogsParams , callback : getMessageChangeLogsHandler ) : void ;
626
+
534
627
getMyMutedInfo ( callback : getMyMutedInfoHandler ) : void ;
535
628
createOperatorListQuery ( ) : OperatorListQuery ;
536
629
537
630
/** Message */
538
631
createMessageListQuery ( ) : MessageListQuery /* DEPRECATED */ ;
539
632
createPreviousMessageListQuery ( ) : PreviousMessageListQuery ;
633
+
634
+ /* DEPRECATED */
540
635
getNextMessagesByTimestamp (
541
636
ts : number ,
542
637
isInclusive : boolean ,
@@ -790,6 +885,9 @@ declare namespace SendBird {
790
885
callback : messageListCallback
791
886
) : void ;
792
887
888
+ getMessagesByTimestamp ( timestamp : number , params : MessageListParams , callback : messageListCallback ) : void ;
889
+ getMessagesByMessageId ( messageId : number , params : MessageListParams , callback : messageListCallback ) : void ;
890
+
793
891
/** FileMessage */
794
892
sendFileMessage ( fileMessageParams : FileMessageParams , callback : messageCallback ) : FileMessage ;
795
893
sendFileMessage ( file : File , callback : messageCallback ) : FileMessage ;
@@ -1074,6 +1172,15 @@ declare namespace SendBird {
1074
1172
) : void ;
1075
1173
}
1076
1174
1175
+ type threadedMessageList = {
1176
+ parentMessage : UserMessage | FileMessage | AdminMessage ,
1177
+ threadedReplies : Array < UserMessage | FileMessage | AdminMessage >
1178
+ } ;
1179
+ type threadedMessageCallback = (
1180
+ threadedMessageList : threadedMessageList ,
1181
+ error : SendBirdError
1182
+ ) => void ;
1183
+
1077
1184
interface PreviousMessageListQuery {
1078
1185
hasMore : boolean ;
1079
1186
isLoading : boolean ;
@@ -1084,6 +1191,9 @@ declare namespace SendBird {
1084
1191
senderUserIdsFilter : Array < string > ;
1085
1192
includeMetaArray : boolean ;
1086
1193
includeReaction : boolean ;
1194
+ includeReplies : boolean ;
1195
+ includeParentMessageText : boolean ;
1196
+ includeThreadInfo : boolean ;
1087
1197
1088
1198
load ( limit : number , reverse : boolean , callback : messageListCallback ) : void ;
1089
1199
load ( limit : number , reverse : boolean , messageType : number , callback : messageListCallback ) : void ;
@@ -1381,6 +1491,20 @@ declare namespace SendBird {
1381
1491
updatedAt : number ;
1382
1492
}
1383
1493
1494
+ interface ThreadInfo {
1495
+ new ( ) : ThreadInfo ;
1496
+ replyCount : number ;
1497
+ mostRepliedUsers : Array < User >
1498
+ lastRepliedAt : number ;
1499
+ }
1500
+ interface ThreadInfoUpdateEvent {
1501
+ new ( ) : ThreadInfoUpdateEvent ;
1502
+ threadInfo : ThreadInfo ;
1503
+ targetMessageId : number ;
1504
+ channelUrl : string ;
1505
+ channelType : string ;
1506
+ }
1507
+
1384
1508
type groupChannelCallback = ( groupChannel : GroupChannel , error : SendBirdError ) => void ;
1385
1509
type distinctGroupChannelCallback = ( response : DistinctGroupChannelResponse , error : SendBirdError ) => void ;
1386
1510
type getPushPreferenceCallback = ( isPushOn : boolean , error : SendBirdError ) => void ;
0 commit comments