Skip to content

Commit ad3e85c

Browse files
author
James.kim
committed
SDK version upgrade
1 parent 51371eb commit ad3e85c

File tree

6 files changed

+318
-13
lines changed

6 files changed

+318
-13
lines changed

CHANGELOG.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
Changelog
22
=========
33

4-
## v3.0.3
4+
## v3.0.4
5+
### update
6+
* `createPreviousMessageListQuery` bugfix.
7+
* npm bundle bugfix.
58

9+
## v3.0.3
610
### update
711
* npm publish.
812

913

1014
## v3.0.2
11-
1215
### update
1316
* Reconnect bugfix.
1417
* `getMetaCounters`, `getMetaData` bugfix.
1518

1619

1720
## v3.0.1
18-
1921
### update
2022
* `blockUserWithUserId` bugfix.
2123

2224

2325
## v3.0.0
24-
2526
### update
26-
* v3.0.0 release.
27+
* v3.0.0 release.

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ SendBird-SDK-JavaScript
2727
# [Documentation](https://docs.sendbird.com/javascript)
2828

2929

30-
## Upgrading to v3.0.3
30+
## Upgrading to v3.0.4
3131
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).
3232

33-
* npm publish.
33+
* `createPreviousMessageListQuery` bugfix.
34+
* npm bundle bugfix.
3435

3536

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

SendBird.d.ts

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,303 @@
1+
// Type definitions for SendBird 3.0.x
2+
// Project: https://sendbird.com/
3+
4+
interface SendBirdFactory {
5+
new(option: Object): SendBird_Instance;
6+
}
7+
8+
9+
/**
10+
* Interface for the SendBird Main
11+
*/
12+
interface SendBird_Instance {
13+
connect(userId: string, callback?: Function): void;
14+
connect(userId: string, accessToken: string, callback?: Function): void;
15+
16+
getConnectionState(): string;
17+
getApplicationId(): string;
18+
19+
updateCurrentUserInfo(nickname: string, profileImage: string, callback?: Function): void;
20+
21+
// Push token
22+
registerGCMPushTokenForCurrentUser(gcmRegToken: string, callback?: Function): void;
23+
unregisterGCMPushTokenForCurrentUser(gcmRegToken: string, callback?: Function): void;
24+
unregisterGCMPushTokenAllForCurrentUser(callback?: Function): void;
25+
26+
registerAPNSPushTokenForCurrentUser(apnsRegToken: string, callback?: Function): void;
27+
unregisterAPNSPushTokenForCurrentUser(apnsRegToken: string, callback?: Function): void;
28+
unregisterAPNSPushTokenAllForCurrentUser(callback: Function): void;
29+
30+
// Block / Unblock
31+
blockUser(userToBlock: User, callback?: Function): void;
32+
blockUserWithUserId(userToBlock: string, callback?: Function): void;
33+
34+
unblockUser(blockedUser: User, callback?: Function): void;
35+
unblockUserWithUserId(blockedUserId: string, callback?: Function): void;
36+
37+
// Channel Handler
38+
ChannelHandler: ChannelHandlerFactory;
39+
40+
addChannelHandler(id: string, handler: ChannelHandlerFactory): void;
41+
removeChannelHandler(id: string): void;
42+
43+
// Connection Handler
44+
ConnectionHandler(): void;
45+
46+
addConnectionHandler(id: string, handler: ConnectionHandler): void;
47+
removeConnectionHandler(id: string): void;
48+
49+
createUserListQuery(): UserListQuery;
50+
createBlockedUserListQuery(): UserListQuery;
51+
52+
currentUser: User;
53+
GroupChannel: GroupChannel;
54+
OpenChannel: OpenChannel;
55+
UserMessage: UserMessage;
56+
}
57+
58+
interface ConnectionHandler {
59+
onReconnectStarted(): void;
60+
onReconnectSucceeded(): void;
61+
onReconnectFailed(): void;
62+
}
63+
64+
65+
/**
66+
* User
67+
*/
68+
interface User {
69+
nickname: string;
70+
profileUrl: string;
71+
userId: string;
72+
connectionStatus: string;
73+
lastSeenAt: string;
74+
}
75+
76+
interface UserListQuery {
77+
hasNext: boolean;
78+
limit: number;
79+
isLoading: boolean;
80+
81+
next(callback: Function): void;
82+
}
83+
84+
85+
/**
86+
* Message
87+
*/
88+
interface BaseMessage {
89+
isGroupChannel(): boolean;
90+
isOpenChannel(): boolean;
91+
92+
isUserMessage(): boolean;
93+
isAdminMessage(): boolean;
94+
isFileMessage(): boolean;
95+
96+
channelUrl: string;
97+
messageId: number;
98+
createdAt: number;
99+
channelType: string;
100+
messageType: string;
101+
}
102+
103+
interface AdminMessage extends BaseMessage {
104+
message: string;
105+
data: string;
106+
}
107+
108+
interface UserMessage extends BaseMessage {
109+
message: string;
110+
data: string;
111+
sender: User;
112+
}
113+
114+
interface FileMessage extends BaseMessage {
115+
message: string;
116+
sender: User;
117+
118+
url: string;
119+
name: string;
120+
size: number;
121+
type: string;
122+
data: string;
123+
}
124+
125+
interface MessageListQuery {
126+
next(messageTimestamp: number, limit: number, reverse: boolean, callback: Function): void;
127+
prev(messageTimestamp: number, limit: number, reverse: boolean, callback: Function): void;
128+
load(messageTimestamp: number, prevLimit: number, nextLimit: number, reverse: boolean, callback: Function): void;
129+
}
130+
131+
interface PreviousMessageListQuery {
132+
hasMore: boolean;
133+
load(limit: number, reverse: boolean, callback: Function): void;
134+
}
135+
136+
137+
/**
138+
* Channel
139+
*/
140+
interface BaseChannel {
141+
isGroupChannel: boolean;
142+
isOpenChannel: boolean;
143+
144+
url: string;
145+
name: string;
146+
coverUrl: string;
147+
createdAt: number;
148+
data: string;
149+
150+
createPreviousMessageListQuery: PreviousMessageListQuery;
151+
createMessageListQuery: MessageListQuery;
152+
153+
/* SendMessage */
154+
sendFileMessage(file: any, callback: Function): void;
155+
sendFileMessage(file: any, data: string, callback: Function): void;
156+
sendFileMessage(file: any, name: string, type: string, size: number, data: string, callback: Function): void;
157+
158+
sendUserMessage(message: string, callback: Function): void;
159+
sendUserMessage(message: string, data: string, callback: Function): void;
160+
161+
/* MetaCounter */
162+
createMetaCounters(metaCounterMap: Object, callback: Function): void;
163+
updateMetaCounters(metaCounterMap: Object, upsert: boolean, callback: Function): void;
164+
increaseMetaCounters(metaCounterMap: Object, callback: Function): void;
165+
decreaseMetaCounters(metaCounterMap: Object, callback: Function): void;
166+
getMetaCounters(keys: Object, callback: Function): void;
167+
getAllMetaCounters(callback: Function): void;
168+
deleteMetaCounter(key: string, callback: Function): void;
169+
deleteAllMetaCounters(callback: Function): void;
170+
171+
/* MetaData */
172+
createMetaData(metaDataMap: Object, callback: Function): void;
173+
updateMetaData(metaDataMap: Object, upsert: boolean, callback: Function): void;
174+
getMetaData(keys: Object, callback: Function): void;
175+
getAllMetaData(callback: Function): void;
176+
deleteMetaData(key: string, callback: Function): void;
177+
deleteAllMetaData(callback: Function): void;
178+
179+
deleteMessage(message: FileMessage|UserMessage, callback: Function): void;
180+
}
181+
182+
interface ChannelHandlerFactory {
183+
new(): ChannelHandler_Instance;
184+
}
185+
186+
interface ChannelHandler_Instance {
187+
onMessageReceived(channel: GroupChannel|OpenChannel, message: AdminMessage|UserMessage): void;
188+
onMessageDeleted(channel: GroupChannel, messageId: string): void;
189+
onReadReceiptUpdated(channel: GroupChannel): void;
190+
onTypingStatusUpdated(channel: GroupChannel): void;
191+
onTypingStatusUpdated(channel: GroupChannel): void;
192+
onUserJoined(channel: GroupChannel, user: User): void;
193+
onUserLeft(channel: GroupChannel, user: User): void;
194+
onUserEntered(channel: OpenChannel, user: User): void;
195+
onUserExited(channel: OpenChannel, user: User): void;
196+
onUserMuted(channel: OpenChannel, user: User): void;
197+
onUserUnmuted(channel: OpenChannel, user: User): void;
198+
onUserBanned(channel: OpenChannel, user: User): void;
199+
onUserUnbanned(channel: OpenChannel, user: User): void;
200+
onChannelFrozen(channel: OpenChannel): void;
201+
onChannelUnfrozen(channel: OpenChannel): void;
202+
onChannelChanged(channel: OpenChannel|GroupChannel): void;
203+
onChannelDeleted(channel: OpenChannel|GroupChannel): void;
204+
}
205+
206+
207+
/**
208+
* Open Channel
209+
*/
210+
interface OpenChannel extends BaseChannel {
211+
212+
createChannel(callback: Function): void;
213+
createChannel(name: string, coverUrl: string, data: any, callback: Function): void;
214+
createChannel(name: string, coverUrl: string, data: any, operatorUserIds: any, callback: Function): void;
215+
216+
enter(callback: Function): void;
217+
exit(callback: Function): void;
218+
219+
getChannel(channelUrl: string, callback: Function): void;
220+
221+
refresh(): void;
222+
223+
createParticipantListQuery(): UserListQuery;
224+
createMutedUserListQuery(): UserListQuery;
225+
createBannedUserListQuery(): UserListQuery;
226+
227+
banUser(user: User, seconds: number, callback: Function): void;
228+
banUserWithUserId(userId: string, seconds: number, callback: Function): void;
229+
230+
unbanUser(user: User, callback: Function): void;
231+
unbanUserWithUserId(userId: string, callback: Function): void;
232+
233+
muteUser(user: User, callback: Function): void;
234+
muteUserWithUserId(userId: string, callback: Function): void;
235+
236+
unmuteUser(user: User, callback: Function): void;
237+
unmuteUserWithUserId(userId: string, callback: Function): void;
238+
239+
isOperator(user: User): boolean;
240+
isOperatorWithUserId(userId: string): boolean;
241+
242+
createOpenChannelListQuery(): OpenChannelListQuery;
243+
}
244+
245+
interface OpenChannelListQuery {
246+
limit: number;
247+
hasNext: boolean;
248+
next(callback: Function): void;
249+
}
250+
251+
interface OpenChannelParticipantListQuery {
252+
limit: number;
253+
hasNext: boolean;
254+
mutedOnly: boolean;
255+
next(callback: Function): void;
256+
}
257+
258+
259+
/**
260+
* Group Channel
261+
*/
262+
interface GroupChannelListQuery {
263+
limit: number;
264+
includeEmpty: boolean;
265+
order: string;
266+
hasNext: boolean;
267+
next(callback: Function): void;
268+
}
269+
270+
interface GroupChannel extends BaseChannel {
271+
createChannel(users: [User], isDistinct: boolean, callback: Function): void;
272+
createChannel(users: [User], isDistinct: boolean, name: string, coverUrl: string, data: any, callback: Function): void;
273+
274+
markAsRead(): void;
275+
markAsReadAll(callback: Function): void;
276+
277+
refresh(callback: Function): void;
278+
279+
invite(users: [User], callback: Function): void;
280+
inviteWithUserIds(userIds: [string], callback: Function): void;
281+
282+
hide(callback: Function): void;
283+
leave(callback: Function): void;
284+
markAsRead(): void;
285+
286+
getReadReceipt(message: UserMessage): number;
287+
updateReadReceipt(userId: string, timestamp: number): void;
288+
289+
startTyping(): void;
290+
endTyping(): void;
291+
isTyping(): boolean;
292+
getTypingMembers(): [number, User];
293+
294+
isDistinct: boolean;
295+
unreadMessageCount: number;
296+
members: [number, User];
297+
lastMessage: string;
298+
memberCount: number;
299+
300+
createMyGroupChannelListQuery(): GroupChannelListQuery;
301+
}
302+
303+
declare var SendBird: SendBirdFactory;

SendBird.min.js

Lines changed: 4 additions & 4 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.3",
3+
"version": "3.0.4",
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.3",
3+
"version": "3.0.4",
44
"description": "SendBird JavaScript SDK",
55
"main": "SendBird.min.js",
66
"dependencies": {

0 commit comments

Comments
 (0)