Skip to content

Commit 6e5e7c6

Browse files
gignac-chagignac-cha
committed
v3.0.159
1 parent ad00f42 commit 6e5e7c6

File tree

7 files changed

+103
-19
lines changed

7 files changed

+103
-19
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## v3.0.159(OCT 26, 2021)
4+
- Changed `User` to `RestrictedUser` when `MutedUserListQuery` and `BannedUserListQuery` fetch users.
5+
- Changed `User` to `RestrictedUser` in `onUserMuted` and `onUserBanned` in `ChannelHandler`.
6+
- Added `restrictionInfo` in `Member`.
7+
38
## v3.0.158(OCT 06, 2021)
49
- Improved stability.
510

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,10 @@ The `sb.setErrorFirstCallback(false)` returns callbacks to their original parame
325325

326326
## Changelogs
327327

328-
### v3.0.158(OCT 06, 2021)
328+
### v3.0.159(OCT 26, 2021)
329329

330330
If you want to check the record of other versions, go to [Change Log](https://github.com/sendbird/Sendbird-SDK-JavaScript/blob/master/CHANGELOG.md).
331331

332-
- Improved stability.
333-
332+
- Changed `User` to `RestrictedUser` when `MutedUserListQuery` and `BannedUserListQuery` fetch users.
333+
- Changed `User` to `RestrictedUser` in `onUserMuted` and `onUserBanned` in `ChannelHandler`.
334+
- Added `restrictionInfo` in `Member`.

‎SendBird.d.ts‎

Lines changed: 70 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Type Definitions for Sendbird SDK v3.0.158
2+
* Type Definitions for Sendbird SDK v3.0.159
33
* homepage: https://sendbird.com/
44
* git: https://github.com/sendbird/Sendbird-SDK-JavaScript
55
*/
@@ -88,21 +88,34 @@ declare namespace SendBird {
8888
REMOVED: 'removed'
8989
};
9090

91+
type ReplyType = {
92+
ALL: 'all',
93+
NONE: 'none',
94+
ONLY_REPLY_TO_CHANNEL: 'only_reply_to_channel'
95+
}
96+
97+
type RestrictionType = {
98+
MUTED: 'muted',
99+
BANNED: 'banned'
100+
};
101+
91102
interface DiscoveryObject {
92103
friendDiscoveryKey: string;
93104
friendName?: string;
94105
}
95106
interface SendBirdInstance {
96107
User: UserStatic;
97108
Member: MemberStatic;
109+
RestrictedUser: RestrictedUserStatic;
98110
BaseChannel: {
99111
MessageTypeFilter: MessageTypeFilter;
100112
};
101113
OpenChannel: OpenChannelStatic;
102114
GroupChannel: GroupChannelStatic;
103115

104116
BaseMessage: {
105-
getMessage(params: MessageRetrievalParams, callback?: messageCallback): Promise<BaseMessageInstance>;
117+
ReplyType: ReplyType;
118+
getMessage(params: MessageRetrievalParams, callback?: messageCallback): Promise<UserMessage | FileMessage | AdminMessage>;
106119
};
107120
UserMessage: UserMessageStatic;
108121
FileMessage: FileMessageStatic;
@@ -442,6 +455,8 @@ declare namespace SendBird {
442455
threadInfo: ThreadInfo;
443456
ogMetaData: OGMetaData;
444457
appleCriticalAlertOptions: AppleCriticalAlertOptions;
458+
isReplyToChannel: boolean;
459+
parentMessage: UserMessage | FileMessage | AdminMessage;
445460

446461
isEqual(target: BaseMessageInstance): boolean;
447462
isIdentical(target: BaseMessageInstance): boolean;
@@ -456,8 +471,8 @@ declare namespace SendBird {
456471
getThreadedMessagesByTimestamp(
457472
timestamp: number,
458473
params: ThreadedMessageListParams,
459-
callback?: messageListCallback
460-
): Promise<Object>;
474+
callback?: threadedMessageCallback
475+
): Promise<ThreadedMessageListInfo>;
461476
applyThreadInfoUpdateEvent(event: ThreadInfoUpdateEvent): boolean;
462477

463478
/**
@@ -524,6 +539,7 @@ declare namespace SendBird {
524539
pushNotificationDeliveryOption: 'default' | 'suppress';
525540
parentMessageId: number;
526541
appleCriticalAlertOptions: AppleCriticalAlertOptions;
542+
isReplyToChannel: boolean;
527543
}
528544
interface UserMessage extends BaseMessageInstance {
529545
messageType: 'user';
@@ -569,6 +585,7 @@ declare namespace SendBird {
569585
pushNotificationDeliveryOption: 'default' | 'suppress';
570586
parentMessageId: number;
571587
appleCriticalAlertOptions: AppleCriticalAlertOptions;
588+
isReplyToChannel: boolean;
572589
}
573590
interface FileMessage extends BaseMessageInstance {
574591
messageType: 'file';
@@ -601,8 +618,12 @@ declare namespace SendBird {
601618
messageId: number;
602619
includeMetaArray: boolean;
603620
includeReactions: boolean;
621+
/**
622+
* @deprecated since version v3.0.159, please use {@link includeParentMessageInfo} instead
623+
*/
604624
includeParentMessageText: boolean;
605625
includeThreadInfo: boolean;
626+
includeParentMessageInfo: boolean;
606627
includePollDetails: boolean;
607628
}
608629
interface MessageListParams {
@@ -624,11 +645,21 @@ declare namespace SendBird {
624645
*/
625646
includeReaction: boolean;
626647
includeReactions: boolean;
648+
/**
649+
* @deprecated since version v3.0.159, please use {@link replyType} instead
650+
*/
627651
includeReplies: boolean;
652+
/**
653+
* @deprecated since version v3.0.159, please use {@link includeParentMessageInfo} instead
654+
*/
628655
includeParentMessageText: boolean;
629656
includeThreadInfo: boolean;
630657
showSubchannelMessagesOnly: boolean;
658+
replyType: ReplyType[keyof ReplyType];
659+
includeParentMessageInfo: boolean;
631660
includePollDetails: boolean;
661+
662+
belongsTo(messageParams: UserMessageParams | FileMessageParams);
632663
}
633664
interface ThreadedMessageListParams {
634665
new(): ThreadedMessageListParams;
@@ -649,7 +680,11 @@ declare namespace SendBird {
649680
*/
650681
includeReaction: boolean;
651682
includeReactions: boolean;
683+
/**
684+
* @deprecated since version v3.0.159, please use {@link includeParentMessageInfo} instead
685+
*/
652686
includeParentMessageText: boolean;
687+
includeParentMessageInfo: boolean;
653688
includePollDetails: boolean;
654689
}
655690
interface MessageChangeLogsParams {
@@ -660,9 +695,17 @@ declare namespace SendBird {
660695
*/
661696
includeReaction: boolean;
662697
includeReactions: boolean;
698+
/**
699+
* @deprecated since version v3.0.159, please use {@link replyType} instead
700+
*/
663701
includeReplies: boolean;
702+
/**
703+
* @deprecated since version v3.0.159, please use {@link includeParentMessageInfo} instead
704+
*/
664705
includeParentMessageText: boolean;
665706
includeThreadInfo: boolean;
707+
replyType: ReplyType[keyof ReplyType];
708+
includeParentMessageInfo: boolean;
666709
includePollDetails: boolean;
667710
}
668711

@@ -721,11 +764,24 @@ declare namespace SendBird {
721764
isMuted: boolean;
722765
isBlockedByMe: boolean;
723766
isBlockingMe: boolean;
767+
restrictionInfo: RestrictionInfo;
724768
}
725769
interface MemberStatic {
726770
buildFromSerializedData(serializedObject: Object): Member;
727771
}
728772

773+
interface RestrictionInfo {
774+
restrictionType: RestrictionType[keyof RestrictionType];
775+
description: string;
776+
endAt: number;
777+
}
778+
interface RestrictedUser extends User {
779+
restrictionInfo: RestrictionInfo;
780+
}
781+
interface RestrictedUserStatic {
782+
RestrictionType: RestrictionType;
783+
}
784+
729785
/**
730786
* Channel
731787
*/
@@ -1501,6 +1557,7 @@ declare namespace SendBird {
15011557
messageList: Array<UserMessage | FileMessage | AdminMessage>,
15021558
error: SendBirdError
15031559
) => void;
1560+
15041561
/**
15051562
* @deprecated since version v3.0.36, please use {@link PreviousMessageListQuery} instead
15061563
*/
@@ -1516,11 +1573,16 @@ declare namespace SendBird {
15161573
): void;
15171574
}
15181575

1519-
type threadedMessageList = {
1576+
type ThreadedMessageListInfo = {
15201577
parentMessage: UserMessage | FileMessage | AdminMessage;
15211578
threadedReplies: Array<UserMessage | FileMessage | AdminMessage>;
15221579
};
1523-
type threadedMessageCallback = (threadedMessageList: threadedMessageList, error: SendBirdError) => void;
1580+
/**
1581+
* @deprecated since version v3.0.27, please use {@link SendBirdInstance.setErrorFirstCallback}
1582+
*/
1583+
type threadedMessageErrorLastCallback = (threadedMessageListInfo: ThreadedMessageListInfo, error: SendBirdError) => void;
1584+
type threadedMessageErrorFirstCallback = (error: SendBirdError, threadedMessageListInfo: ThreadedMessageListInfo) => void;
1585+
type threadedMessageCallback = threadedMessageErrorFirstCallback | threadedMessageErrorLastCallback;
15241586

15251587
interface PreviousMessageListQuery {
15261588
hasMore: boolean;
@@ -1681,15 +1743,15 @@ declare namespace SendBird {
16811743
hasNext: boolean;
16821744
isLoading: boolean;
16831745

1684-
next(callback?: userListQueryCallback): Promise<Array<User>>;
1746+
next(callback?: userListQueryCallback): Promise<Array<RestrictedUser>>;
16851747
}
16861748

16871749
interface BannedUserListQuery {
16881750
limit: number;
16891751
hasNext: boolean;
16901752
isLoading: boolean;
16911753

1692-
next(callback?: userListQueryCallback): Promise<Array<User>>;
1754+
next(callback?: userListQueryCallback): Promise<Array<RestrictedUser>>;
16931755
}
16941756

16951757
interface OperatorListQuery {

‎SendBird.min.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎bower.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sendbird",
3-
"version": "3.0.158",
3+
"version": "3.0.159",
44
"authors": [
55
"Sendbird <[email protected]>"
66
],

‎deprecated.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11
# Deprecated classes, methods, properties
22

33

4+
## v3.0.159
5+
6+
### Methods
7+
8+
| Old class | Old property | New class | New property |
9+
| --------- | ----------- | --------- | ---------- |
10+
| MessageRetrievalParams | includeParentMessageText: boolean | MessageRetrievalParams | includeParentMessageInfo: boolean |
11+
| PreviousMessageListQuery | includeParentMessageText: boolean | PreviousMessageListQuery | includeParentMessageInfo: boolean |
12+
| PreviousMessageListQuery | includeReplies: boolean | PreviousMessageListQuery | replyType: ReplyType |
13+
| MessageListParams | includeParentMessageText: boolean | MessageListParams | includeParentMessageInfo: boolean |
14+
| MessageListParams | includeReplies: boolean | MessageListParams | replyType: ReplyType |
15+
| ThreadedMessageListParams | includeParentMessageText: boolean | ThreadedMessageListParams | includeParentMessageInfo: boolean |
16+
| MessageChangeLogsParams | includeParentMessageText: boolean | MessageChangeLogsParams | includeParentMessageInfo: boolean |
17+
| MessageChangeLogsParams | includeReplies: boolean | MessageChangeLogsParams | replyType: ReplyType |
18+
19+
420
## v3.0.156
521

622
### Methods
723

8-
| Old class | Old pmethod | New class | New method |
24+
| Old class | Old method | New class | New method |
925
| --------- | ----------- | --------- | ---------- |
1026
| GroupChannel | markAsRead(): void | GroupChannel | markAsRead(callback: VoidCallback): Promise&lt;void&gt; |
1127

@@ -14,7 +30,7 @@
1430

1531
### Methods
1632

17-
| Old class | Old pmethod | New class | New method |
33+
| Old class | Old method | New class | New method |
1834
| --------- | ----------- | --------- | ---------- |
1935
| GroupChannel | markAsDelivered(): void | SendBird | markAsDelivered(channelUrl: String): void |
2036

@@ -60,8 +76,8 @@
6076

6177
| Old class | Old method | New class | New method |
6278
| --------- | ---------- | --------- | ---------- |
63-
| GroupChannel | getReadReceipt(message: UserMessage | FileMessage): number | GroupChannel | getUnreadMemberCount(message: UserMessage | FileMessage): number |
64-
| GroupChannel | getDeliveryReceipt(message: UserMessage | FileMessage): number | GroupChannel | getUndeliveredMemberCount(message: UserMessage | FileMessage): number |
79+
| GroupChannel | getReadReceipt(message: UserMessage &#124; FileMessage): number | GroupChannel | getUnreadMemberCount(message: UserMessage &#124; FileMessage): number |
80+
| GroupChannel | getDeliveryReceipt(message: UserMessage &#124; FileMessage): number | GroupChannel | getUndeliveredMemberCount(message: UserMessage &#124; FileMessage): number |
6581

6682

6783
## v3.0.125

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sendbird",
3-
"version": "3.0.158",
3+
"version": "3.0.159",
44
"description": "Sendbird JavaScript SDK",
55
"main": "SendBird.min.js",
66
"dependencies": {

0 commit comments

Comments
 (0)