Skip to content

Commit a01c175

Browse files
authored
Update README.md
1 parent 331d198 commit a01c175

File tree

1 file changed

+76
-85
lines changed

1 file changed

+76
-85
lines changed

README.md

Lines changed: 76 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -78,31 +78,22 @@ Do you prefer other programming languages?
7878
TikTokLive.newClient("bangbetmenygy")
7979
.onGift((liveClient, event) ->
8080
{
81-
String profileName = event.getUser().getProfileName();
8281
String message = switch (event.getGift()) {
8382
case ROSE -> "ROSE!";
8483
case GG -> "GOOD GAME";
8584
case TIKTOK -> "Ye";
8685
case CORGI -> "Nice gift";
8786
default -> "Thank you for " + event.getGift().getName();
8887
};
89-
System.out.println(profileName + " sends " + message);
88+
System.out.println(event.getUser().getProfileName() + " sends " + message);
9089
})
9190
.onGiftCombo((liveClient, event) ->
9291
{
93-
String giftName = event.getGift().getName();
94-
int combo = event.getCombo();
95-
String message = switch (event.getComboState()) {
96-
case Begin -> "Combo begin! ";
97-
case Active -> "Combo Active! ";
98-
case Finished -> "Combo Finished! ";
99-
};
100-
System.out.println(message + combo + " " + giftName);
92+
System.out.println(event.getComboState()+ " " + event.getCombo() + " " + event.getGift().getName());
10193
})
10294
.onJoin((liveClient, event) ->
10395
{
104-
String profileName = event.getUser().getProfileName();
105-
System.out.println(profileName + "Hello on my stream! ");
96+
System.out.println(event.getUser().getProfileName() + "Hello on my stream! ");
10697
})
10798
.onConnected((liveClient, event) ->
10899
{
@@ -151,29 +142,29 @@ TikTokLive.newClient("bangbetmenygy")
151142

152143
**Control**:
153144

154-
- [onError](#onerror-tiktokerrorevent)
155145
- [onConnected](#onconnected-tiktokconnectedevent)
156-
- [onDisconnected](#ondisconnected-tiktokdisconnectedevent)
157146
- [onReconnecting](#onreconnecting-tiktokreconnectingevent)
147+
- [onDisconnected](#ondisconnected-tiktokdisconnectedevent)
148+
- [onError](#onerror-tiktokerrorevent)
158149

159150
**Message**:
160151

161152
- [onEvent](#onevent-tiktokevent)
153+
- [onShare](#onshare-tiktokshareevent)
154+
- [onLivePaused](#onlivepaused-tiktoklivepausedevent)
162155
- [onRoom](#onroom-tiktokroomevent)
156+
- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent)
157+
- [onJoin](#onjoin-tiktokjoinevent)
163158
- [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent)
164159
- [onComment](#oncomment-tiktokcommentevent)
165-
- [onJoin](#onjoin-tiktokjoinevent)
166-
- [onFollow](#onfollow-tiktokfollowevent)
160+
- [onGift](#ongift-tiktokgiftevent)
161+
- [onLike](#onlike-tiktoklikeevent)
167162
- [onSubscribe](#onsubscribe-tiktoksubscribeevent)
168-
- [onShare](#onshare-tiktokshareevent)
169163
- [onQuestion](#onquestion-tiktokquestionevent)
170-
- [onLike](#onlike-tiktoklikeevent)
171-
- [onLivePaused](#onlivepaused-tiktoklivepausedevent)
172-
- [onGift](#ongift-tiktokgiftevent)
173-
- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent)
174-
- [onLiveEnded](#onliveended-tiktokliveendedevent)
175164
- [onEmote](#onemote-tiktokemoteevent)
176-
- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent)
165+
- [onLiveEnded](#onliveended-tiktokliveendedevent)
166+
- [onFollow](#onfollow-tiktokfollowevent)
167+
- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent)
177168

178169
**Debug**:
179170

@@ -183,15 +174,15 @@ TikTokLive.newClient("bangbetmenygy")
183174
# Examples
184175
<br>
185176

186-
## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokErrorEvent.java)
177+
## onConnected [TikTokConnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokConnectedEvent.java)
187178

188179

189-
General error event. You should handle this.
180+
Triggered when the connection is successfully established.
190181

191182

192183
```java
193184
TikTokLive.newClient("host-name")
194-
.onError((liveClient, event) ->
185+
.onConnected((liveClient, event) ->
195186
{
196187

197188
})
@@ -202,15 +193,13 @@ TikTokLive.newClient("host-name")
202193

203194
<br>
204195

205-
## onConnected [TikTokConnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokConnectedEvent.java)
196+
## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokReconnectingEvent.java)
206197

207198

208-
Triggered when the connection is successfully established.
209-
210199

211200
```java
212201
TikTokLive.newClient("host-name")
213-
.onConnected((liveClient, event) ->
202+
.onReconnecting((liveClient, event) ->
214203
{
215204

216205
})
@@ -241,13 +230,15 @@ TikTokLive.newClient("host-name")
241230

242231
<br>
243232

244-
## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokReconnectingEvent.java)
233+
## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokErrorEvent.java)
245234

246235

236+
General error event. You should handle this.
237+
247238

248239
```java
249240
TikTokLive.newClient("host-name")
250-
.onReconnecting((liveClient, event) ->
241+
.onError((liveClient, event) ->
251242
{
252243

253244
})
@@ -277,13 +268,15 @@ TikTokLive.newClient("host-name")
277268

278269
<br>
279270

280-
## onRoom [TikTokRoomEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomEvent.java)
271+
## onShare [TikTokShareEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokShareEvent.java)
281272

282273

274+
Triggers when a user shares the stream. Based on social event.
275+
283276

284277
```java
285278
TikTokLive.newClient("host-name")
286-
.onRoom((liveClient, event) ->
279+
.onShare((liveClient, event) ->
287280
{
288281

289282
})
@@ -294,16 +287,13 @@ TikTokLive.newClient("host-name")
294287

295288
<br>
296289

297-
## onRoomUserInfo [TikTokRoomUserInfoEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomUserInfoEvent.java)
290+
## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLivePausedEvent.java)
298291

299292

300-
Only top 5 users in ranking has detailed data
301-
rest has only ID
302-
303293

304294
```java
305295
TikTokLive.newClient("host-name")
306-
.onRoomUserInfo((liveClient, event) ->
296+
.onLivePaused((liveClient, event) ->
307297
{
308298

309299
})
@@ -314,15 +304,13 @@ TikTokLive.newClient("host-name")
314304

315305
<br>
316306

317-
## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java)
307+
## onRoom [TikTokRoomEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomEvent.java)
318308

319309

320-
Triggered every time a new chat comment arrives.
321-
322310

323311
```java
324312
TikTokLive.newClient("host-name")
325-
.onComment((liveClient, event) ->
313+
.onRoom((liveClient, event) ->
326314
{
327315

328316
})
@@ -333,13 +321,25 @@ TikTokLive.newClient("host-name")
333321

334322
<br>
335323

336-
## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java)
324+
## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java)
337325

338326

327+
Triggered every time gift is sent
328+
329+
@see GiftSendType it has 3 states
330+
331+
<p>Example when user sends gift with combo</p>
332+
<p>>Combo: 1 -> comboState = GiftSendType.Begin</p>
333+
<p>Combo: 4 -> comboState = GiftSendType.Active</p>
334+
<p>Combo: 8 -> comboState = GiftSendType.Active</p>
335+
<p>Combo: 12 -> comboState = GiftSendType.Finsihed</p>
336+
337+
Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered
338+
339339

340340
```java
341341
TikTokLive.newClient("host-name")
342-
.onJoin((liveClient, event) ->
342+
.onGiftCombo((liveClient, event) ->
343343
{
344344

345345
})
@@ -350,15 +350,13 @@ TikTokLive.newClient("host-name")
350350

351351
<br>
352352

353-
## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java)
353+
## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java)
354354

355355

356-
Triggers when a user follows the streamer. Based on social event.
357-
358356

359357
```java
360358
TikTokLive.newClient("host-name")
361-
.onFollow((liveClient, event) ->
359+
.onJoin((liveClient, event) ->
362360
{
363361

364362
})
@@ -369,15 +367,16 @@ TikTokLive.newClient("host-name")
369367

370368
<br>
371369

372-
## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java)
370+
## onRoomUserInfo [TikTokRoomUserInfoEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomUserInfoEvent.java)
373371

374372

375-
Triggers when a user creates a subscription.
376-
373+
Only top 5 users in ranking has detailed data
374+
rest has only ID
375+
377376

378377
```java
379378
TikTokLive.newClient("host-name")
380-
.onSubscribe((liveClient, event) ->
379+
.onRoomUserInfo((liveClient, event) ->
381380
{
382381

383382
})
@@ -388,15 +387,15 @@ TikTokLive.newClient("host-name")
388387

389388
<br>
390389

391-
## onShare [TikTokShareEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokShareEvent.java)
390+
## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java)
392391

393392

394-
Triggers when a user shares the stream. Based on social event.
393+
Triggered every time a new chat comment arrives.
395394

396395

397396
```java
398397
TikTokLive.newClient("host-name")
399-
.onShare((liveClient, event) ->
398+
.onComment((liveClient, event) ->
400399
{
401400

402401
})
@@ -407,15 +406,17 @@ TikTokLive.newClient("host-name")
407406

408407
<br>
409408

410-
## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java)
409+
## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java)
411410

412411

413-
Triggered every time someone asks a new question via the question feature.
412+
Triggered when user sends gifts that has
413+
no combo (most of expensive gifts)
414+
or if combo has finished
414415

415416

416417
```java
417418
TikTokLive.newClient("host-name")
418-
.onQuestion((liveClient, event) ->
419+
.onGift((liveClient, event) ->
419420
{
420421

421422
})
@@ -445,13 +446,15 @@ TikTokLive.newClient("host-name")
445446

446447
<br>
447448

448-
## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLivePausedEvent.java)
449+
## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java)
449450

450451

452+
Triggers when a user creates a subscription.
453+
451454

452455
```java
453456
TikTokLive.newClient("host-name")
454-
.onLivePaused((liveClient, event) ->
457+
.onSubscribe((liveClient, event) ->
455458
{
456459

457460
})
@@ -462,17 +465,15 @@ TikTokLive.newClient("host-name")
462465

463466
<br>
464467

465-
## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java)
468+
## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java)
466469

467470

468-
Triggered when user sends gifts that has
469-
no combo (most of expensive gifts)
470-
or if combo has finished
471+
Triggered every time someone asks a new question via the question feature.
471472

472473

473474
```java
474475
TikTokLive.newClient("host-name")
475-
.onGift((liveClient, event) ->
476+
.onQuestion((liveClient, event) ->
476477
{
477478

478479
})
@@ -483,13 +484,15 @@ TikTokLive.newClient("host-name")
483484

484485
<br>
485486

486-
## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokUnhandledSocialEvent.java)
487+
## onEmote [TikTokEmoteEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokEmoteEvent.java)
487488

488489

490+
Triggered every time a subscriber sends an emote (sticker).
491+
489492

490493
```java
491494
TikTokLive.newClient("host-name")
492-
.onUnhandledSocial((liveClient, event) ->
495+
.onEmote((liveClient, event) ->
493496
{
494497

495498
})
@@ -519,15 +522,15 @@ TikTokLive.newClient("host-name")
519522

520523
<br>
521524

522-
## onEmote [TikTokEmoteEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokEmoteEvent.java)
525+
## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java)
523526

524527

525-
Triggered every time a subscriber sends an emote (sticker).
528+
Triggers when a user follows the streamer. Based on social event.
526529

527530

528531
```java
529532
TikTokLive.newClient("host-name")
530-
.onEmote((liveClient, event) ->
533+
.onFollow((liveClient, event) ->
531534
{
532535

533536
})
@@ -538,25 +541,13 @@ TikTokLive.newClient("host-name")
538541

539542
<br>
540543

541-
## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java)
544+
## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokUnhandledSocialEvent.java)
542545

543546

544-
Triggered every time gift is sent
545-
546-
@see GiftSendType it has 3 states
547-
548-
<p>Example when user sends gift with combo</p>
549-
<p>>Combo: 1 -> comboState = GiftSendType.Begin</p>
550-
<p>Combo: 4 -> comboState = GiftSendType.Active</p>
551-
<p>Combo: 8 -> comboState = GiftSendType.Active</p>
552-
<p>Combo: 12 -> comboState = GiftSendType.Finsihed</p>
553-
554-
Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered
555-
556547

557548
```java
558549
TikTokLive.newClient("host-name")
559-
.onGiftCombo((liveClient, event) ->
550+
.onUnhandledSocial((liveClient, event) ->
560551
{
561552

562553
})

0 commit comments

Comments
 (0)