Skip to content

Commit ebe6e3f

Browse files
committed
ver3.0.53
1 parent 48ddd1d commit ebe6e3f

File tree

6 files changed

+132
-15
lines changed

6 files changed

+132
-15
lines changed

CHANGELOG.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,43 @@
11
Changelog
22
=========
33

4+
## v3.0.53
5+
* Deprecated `userIdsFilter` in `GroupChannelListQuery`.
6+
* Deprecated `userIdsFilterExactMatch` in `GroupChannelListQuery`.
7+
* Deprecated `queryType` in `GroupChannelListQuery`.
8+
* Added `userIdsExactFilter` in `GroupChannelListQuery` to replace `userIdsFilter` and `userIdsFilterExactMatch`.
9+
* Added `userIdsIncludeFilter` in `GroupChannelListQuery` to replace `userIdsFilter` and `userIdsFilterExactMatch`.
10+
* Added `userIdsIncludeFilterQueryType` in `GroupChannelListQuery` to replace `queryType`.
11+
* Added `customTypeStartsWithFilter` in `GroupChannelListQuery` to search channels based on `customType`.
12+
* Added `superChannelFilter` in `GroupChannelListQuery` to search channels that `isSuper` is true.
13+
* Added `publicChannelFilter` in `GroupChannelListQuery` to search channels that `isPublic` is true.
14+
* Added `GroupChannelParams` feature.
15+
* This is used in `createChannel()` and `updateChannel()` of GroupChannel.
16+
* isDistinct: set isDistinct on creation or update.
17+
* isSuper: set isSuper on creation.
18+
* isPublic: set isPublic on creation or update.
19+
* channelUrl: set url of channel on creation.
20+
* name: set name on creation or update.
21+
* data: set data on creation or update.
22+
* customType: set customType on creation or update.
23+
* coverUrl: set coverUrl on creation or update.
24+
* coverImage: set coverUrl using file on creation or update.
25+
* addUser(): add user to be invited using user instance.
26+
* addUsers(): add user to be invited using user instance array.
27+
* addUserId(): add user to be invited using userId.
28+
* addUserIds(): add user to be invited using userId array.
29+
* Added `PublicGroupChannelListQuery` in `SendBird` to search channels that `isPublic` is true.
30+
* limit: set list count for result.
31+
* includeEmpty: set whether to get channel that conversation is empty.
32+
* order: set order of result.
33+
* channelNameContainsFilter: set channelName to get channels based on.
34+
* channelUrlsFilter: set channelUrls to get channels based on.
35+
* customTypesFilter: set customTypes to get channels based on.
36+
* customTypeStartsWithFilter: set to get channels starting with the passed customType.
37+
* superChannelFilter: set whether to fetch all channels, super channels only, or non-super channels only.
38+
* membershipFilter: set whether to fetch according to the current user state of join.
39+
* next(): get channel list.
40+
441
## v3.0.52
542
* Added `channelUrlsFilter` in `GroupChannelListQuery`.
643

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,43 @@ If you have trouble importing `SendBird`, please check your `tsconfig.json` file
3939
# [Documentation](https://docs.sendbird.com/javascript)
4040

4141

42-
## Upgrading to v3.0.52
42+
## Upgrading to v3.0.53
4343
If you want to check the record of other version, go to [Change Log](https://github.com/smilefam/SendBird-SDK-JavaScript/blob/master/CHANGELOG.md).
44-
* Added `channelUrlsFilter` in `GroupChannelListQuery`.
44+
* Deprecated `userIdsFilter` in `GroupChannelListQuery`.
45+
* Deprecated `userIdsFilterExactMatch` in `GroupChannelListQuery`.
46+
* Deprecated `queryType` in `GroupChannelListQuery`.
47+
* Added `userIdsExactFilter` in `GroupChannelListQuery` to replace `userIdsFilter` and `userIdsFilterExactMatch`.
48+
* Added `userIdsIncludeFilter` in `GroupChannelListQuery` to replace `userIdsFilter` and `userIdsFilterExactMatch`.
49+
* Added `userIdsIncludeFilterQueryType` in `GroupChannelListQuery` to replace `queryType`.
50+
* Added `customTypeStartsWithFilter` in `GroupChannelListQuery` to search channels based on `customType`.
51+
* Added `superChannelFilter` in `GroupChannelListQuery` to search channels that `isSuper` is true.
52+
* Added `publicChannelFilter` in `GroupChannelListQuery` to search channels that `isPublic` is true.
53+
* Added `GroupChannelParams` feature.
54+
* This is used in `createChannel()` and `updateChannel()` of GroupChannel.
55+
* isDistinct: set isDistinct on creation or update.
56+
* isSuper: set isSuper on creation.
57+
* isPublic: set isPublic on creation or update.
58+
* channelUrl: set url of channel on creation.
59+
* name: set name on creation or update.
60+
* data: set data on creation or update.
61+
* customType: set customType on creation or update.
62+
* coverUrl: set coverUrl on creation or update.
63+
* coverImage: set coverUrl using file on creation or update.
64+
* addUser(): add user to be invited using user instance.
65+
* addUsers(): add user to be invited using user instance array.
66+
* addUserId(): add user to be invited using userId.
67+
* addUserIds(): add user to be invited using userId array.
68+
* Added `PublicGroupChannelListQuery` in `SendBird` to search channels that `isPublic` is true.
69+
* limit: set list count for result.
70+
* includeEmpty: set whether to get channel that conversation is empty.
71+
* order: set order of result.
72+
* channelNameContainsFilter: set channelName to get channels based on.
73+
* channelUrlsFilter: set channelUrls to get channels based on.
74+
* customTypesFilter: set customTypes to get channels based on.
75+
* customTypeStartsWithFilter: set to get channels starting with the passed customType.
76+
* superChannelFilter: set whether to fetch all channels, super channels only, or non-super channels only.
77+
* membershipFilter: set whether to fetch according to the current user state of join.
78+
* next(): get channel list.
4579

4680

4781
## [Change Log](https://github.com/smilefam/SendBird-SDK-JavaScript/blob/master/CHANGELOG.md)

SendBird.d.ts

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Type Definitions for SendBird SDK v3.0.52
2+
* Type Definitions for SendBird SDK v3.0.53
33
* homepage: https://sendbird.com/
44
* git: https://github.com/smilefam/SendBird-SDK-JavaScript
55
*/
@@ -41,6 +41,8 @@ interface SendBirdInstance {
4141
ChannelHandler: ChannelHandlerStatic;
4242
ConnectionHandler: ConnectionHandlerStatic;
4343

44+
GroupChannelParams: GroupChannelParams;
45+
4446
connect(userId: string, callback?: userCallback): void;
4547
connect(userId: string, apiHost: string, wsHost: string, callback?: userCallback): void;
4648
connect(userId: string, accessToken: string, callback?: userCallback): void;
@@ -476,11 +478,30 @@ interface OpenChannelListQuery {
476478
/**
477479
* GroupChannel
478480
*/
481+
interface GroupChannelParams {
482+
isDistinct: boolean;
483+
isSuper: boolean;
484+
isPublic: boolean;
485+
channelUrl: string;
486+
name: string;
487+
data: string;
488+
customType: string;
489+
coverUrl: string;
490+
coverImage: File;
491+
492+
addUser(user: User): void;
493+
addUsers(user: Array<User>): void;
494+
addUserId(userId: string): void;
495+
addUserIds(userId: Array<string>): void;
496+
}
497+
479498
type groupChannelCallback = (groupChannel: GroupChannel, error: Object) => void;
480499
type getPushPreferenceCallback = (isPushOn: boolean, error: Object) => void;
481500
interface GroupChannel extends BaseChannel {
482501
isHidden: boolean;
483502
isDistinct: boolean;
503+
isSuper: boolean;
504+
isPublic: boolean;
484505
isPushEnabled: boolean;
485506
lastMessage: UserMessage | FileMessage | AdminMessage;
486507
unreadMessageCount: number;
@@ -490,6 +511,7 @@ interface GroupChannel extends BaseChannel {
490511

491512
refresh(callback: groupChannelCallback): void;
492513

514+
updateChannel(groupChannelParams: GroupChannelParams, callback: groupChannelCallback): void;
493515
updateChannel(name: string, coverUrlOrImageFile: string|File, data: string, callback: groupChannelCallback): void;
494516
updateChannel(isDistinct: boolean, name: string, coverUrlOrImageFile: string|File, data: string, callback: groupChannelCallback): void;
495517
updateChannel(isDistinct: boolean, name: string, coverUrlOrImageFile: string|File, data: string, customType: string, callback: groupChannelCallback): void;
@@ -501,6 +523,7 @@ interface GroupChannel extends BaseChannel {
501523
acceptInvitation(callback: groupChannelCallback): void;
502524
declineInvitation(callback: commonCallback): void;
503525

526+
join(callback: groupChannelCallback): void;
504527
leave(callback: commonCallback): void;
505528

506529
hide(callback: commonCallback): void;
@@ -525,10 +548,12 @@ interface GroupChannelStatic {
525548
buildFromSerializedData(serializedObject: Object): GroupChannel;
526549

527550
createMyGroupChannelListQuery(): GroupChannelListQuery;
551+
createPublicGroupChannelListQuery(): PublicGroupChannelListQuery;
528552

529553
getTotalUnreadMessageCount(callback: groupChannelCountCallback): void;
530554
getTotalUnreadChannelCount(callback: groupChannelCountCallback): void;
531555

556+
createChannel(groupChannelParams: GroupChannelParams, callback: groupChannelCallback): void;
532557
createChannel(users: Array<User>, callback: groupChannelCallback): void;
533558
createChannel(users: Array<User>, isDistinct: boolean, callback: groupChannelCallback): void;
534559
createChannel(users: Array<User>, isDistinct: boolean, customType: string, callback: groupChannelCallback): void;
@@ -553,14 +578,35 @@ interface GroupChannelListQuery {
553578
hasNext: boolean;
554579
isLoading: boolean;
555580
includeEmpty: boolean;
556-
order: string;
557-
userIdsFilter: Array<string>;
558-
userIdsFilterExactMatch: boolean;
559-
queryType: 'AND'|'OR';
581+
order: 'latest_last_message' | 'chronological' | 'channel_name_alphabetical';
582+
userIdsFilter: Array<string>; // Deprecated
583+
userIdsFilterExactMatch: boolean; // Deprecated
584+
queryType: 'AND'|'OR'; // Deprecated
585+
userIdsExactFilter: Array<string>;
586+
userIdsIncludeFilter: Array<string>;
587+
userIdsIncludeFilterQueryType: 'AND'|'OR';
560588
nicknameContainsFilter: string;
561589
channelNameContainsFilter: string;
562590
customTypeFilter: string; // Deprecated
563591
customTypesFilter: Array<string>;
592+
customTypeStartsWithFilter: string;
564593
channelUrlsFilter: Array<string>;
594+
superChannelFilter: 'all' | 'super' | 'nonsuper';
595+
publicChannelFilter: 'all' | 'public' | 'private';
596+
next(callback: groupChannelListQueryCallback): void;
597+
}
598+
599+
interface PublicGroupChannelListQuery {
600+
limit: number;
601+
hasNext: boolean;
602+
isLoading: boolean;
603+
includeEmpty: boolean;
604+
order: 'chronological' | 'channel_name_alphabetical';
605+
channelNameContainsFilter: string;
606+
channelUrlsFilter: Array<string>;
607+
customTypesFilter: Array<string>;
608+
customTypeStartsWithFilter: string;
609+
superChannelFilter: 'all' | 'super' | 'nonsuper';
610+
membershipFilter: 'all' | 'joined';
565611
next(callback: groupChannelListQueryCallback): void;
566612
}

SendBird.min.js

Lines changed: 6 additions & 6 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.52",
3+
"version": "3.0.53",
44
"authors": [
55
"SendBird <[email protected]>"
66
],

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.52",
3+
"version": "3.0.53",
44
"description": "SendBird JavaScript SDK",
55
"main": "SendBird.min.js",
66
"dependencies": {

0 commit comments

Comments
 (0)