diff --git a/README.md b/README.md index c22de2e..d4bdcb7 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,6 @@ Do you prefer other programming languages? TikTokLive.newClient("bangbetmenygy") .onGift((liveClient, event) -> { - String profileName = event.getUser().getProfileName(); String message = switch (event.getGift()) { case ROSE -> "ROSE!"; case GG -> "GOOD GAME"; @@ -86,23 +85,15 @@ TikTokLive.newClient("bangbetmenygy") case CORGI -> "Nice gift"; default -> "Thank you for " + event.getGift().getName(); }; - System.out.println(profileName + " sends " + message); + System.out.println(event.getUser().getProfileName() + " sends " + message); }) .onGiftCombo((liveClient, event) -> { - String giftName = event.getGift().getName(); - int combo = event.getCombo(); - String message = switch (event.getComboState()) { - case Begin -> "Combo begin! "; - case Active -> "Combo Active! "; - case Finished -> "Combo Finished! "; - }; - System.out.println(message + combo + " " + giftName); + System.out.println(event.getComboState()+ " " + event.getCombo() + " " + event.getGift().getName()); }) .onJoin((liveClient, event) -> { - String profileName = event.getUser().getProfileName(); - System.out.println(profileName + "Hello on my stream! "); + System.out.println(event.getUser().getProfileName() + "Hello on my stream! "); }) .onConnected((liveClient, event) -> { @@ -151,29 +142,29 @@ TikTokLive.newClient("bangbetmenygy") **Control**: -- [onError](#onerror-tiktokerrorevent) - [onConnected](#onconnected-tiktokconnectedevent) -- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onReconnecting](#onreconnecting-tiktokreconnectingevent) +- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) +- [onError](#onerror-tiktokerrorevent) **Message**: - [onEvent](#onevent-tiktokevent) +- [onShare](#onshare-tiktokshareevent) +- [onLivePaused](#onlivepaused-tiktoklivepausedevent) - [onRoom](#onroom-tiktokroomevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onJoin](#onjoin-tiktokjoinevent) - [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) - [onComment](#oncomment-tiktokcommentevent) -- [onJoin](#onjoin-tiktokjoinevent) -- [onFollow](#onfollow-tiktokfollowevent) -- [onSubscribe](#onsubscribe-tiktoksubscribeevent) -- [onShare](#onshare-tiktokshareevent) -- [onQuestion](#onquestion-tiktokquestionevent) -- [onLike](#onlike-tiktoklikeevent) -- [onLivePaused](#onlivepaused-tiktoklivepausedevent) - [onGift](#ongift-tiktokgiftevent) -- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) -- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onLike](#onlike-tiktoklikeevent) +- [onSubscribe](#onsubscribe-tiktoksubscribeevent) +- [onQuestion](#onquestion-tiktokquestionevent) - [onEmote](#onemote-tiktokemoteevent) -- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onFollow](#onfollow-tiktokfollowevent) +- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) **Debug**: @@ -181,25 +172,6 @@ TikTokLive.newClient("bangbetmenygy") - [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) # Examples -
- -## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokErrorEvent.java) - - - General error event. You should handle this. - - -```java -TikTokLive.newClient("host-name") -.onError((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - -
## onConnected [TikTokConnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokConnectedEvent.java) @@ -219,6 +191,23 @@ TikTokLive.newClient("host-name") +
+ +## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokReconnectingEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onReconnecting((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + +
## onDisconnected [TikTokDisconnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokDisconnectedEvent.java) @@ -241,13 +230,15 @@ TikTokLive.newClient("host-name")
-## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokReconnectingEvent.java) +## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokErrorEvent.java) + General error event. You should handle this. + ```java TikTokLive.newClient("host-name") -.onReconnecting((liveClient, event) -> +.onError((liveClient, event) -> { }) @@ -275,6 +266,42 @@ TikTokLive.newClient("host-name") +
+ +## onShare [TikTokShareEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokShareEvent.java) + + + Triggers when a user shares the stream. Based on social event. + + +```java +TikTokLive.newClient("host-name") +.onShare((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLivePausedEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onLivePaused((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + +
## onRoom [TikTokRoomEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomEvent.java) @@ -292,6 +319,52 @@ TikTokLive.newClient("host-name") +
+ +## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java) + + + Triggered every time gift is sent + + @see GiftSendType it has 3 states + +

Example when user sends gift with combo

+

>Combo: 1 -> comboState = GiftSendType.Begin

+

Combo: 4 -> comboState = GiftSendType.Active

+

Combo: 8 -> comboState = GiftSendType.Active

+

Combo: 12 -> comboState = GiftSendType.Finsihed

+ + Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered + + +```java +TikTokLive.newClient("host-name") +.onGiftCombo((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onJoin((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + +
## onRoomUserInfo [TikTokRoomUserInfoEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomUserInfoEvent.java) @@ -333,89 +406,17 @@ TikTokLive.newClient("host-name")
-## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java) +## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java) - -```java -TikTokLive.newClient("host-name") -.onJoin((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java) - - - Triggers when a user follows the streamer. Based on social event. + Triggered when user sends gifts that has + no combo (most of expensive gifts) + or if combo has finished ```java TikTokLive.newClient("host-name") -.onFollow((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) - - - Triggers when a user creates a subscription. - - -```java -TikTokLive.newClient("host-name") -.onSubscribe((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onShare [TikTokShareEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokShareEvent.java) - - - Triggers when a user shares the stream. Based on social event. - - -```java -TikTokLive.newClient("host-name") -.onShare((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java) - - -Triggered every time someone asks a new question via the question feature. - - -```java -TikTokLive.newClient("host-name") -.onQuestion((liveClient, event) -> +.onGift((liveClient, event) -> { }) @@ -445,34 +446,15 @@ TikTokLive.newClient("host-name")
-## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLivePausedEvent.java) +## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) - -```java -TikTokLive.newClient("host-name") -.onLivePaused((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java) - - - Triggered when user sends gifts that has - no combo (most of expensive gifts) - or if combo has finished + Triggers when a user creates a subscription. ```java TikTokLive.newClient("host-name") -.onGift((liveClient, event) -> +.onSubscribe((liveClient, event) -> { }) @@ -483,32 +465,15 @@ TikTokLive.newClient("host-name")
-## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokUnhandledSocialEvent.java) +## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java) - -```java -TikTokLive.newClient("host-name") -.onUnhandledSocial((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onLiveEnded [TikTokLiveEndedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLiveEndedEvent.java) - - - Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. +Triggered every time someone asks a new question via the question feature. ```java TikTokLive.newClient("host-name") -.onLiveEnded((liveClient, event) -> +.onQuestion((liveClient, event) -> { }) @@ -538,25 +503,51 @@ TikTokLive.newClient("host-name")
-## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java) +## onLiveEnded [TikTokLiveEndedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLiveEndedEvent.java) - Triggered every time gift is sent - - @see GiftSendType it has 3 states - -

Example when user sends gift with combo

-

>Combo: 1 -> comboState = GiftSendType.Begin

-

Combo: 4 -> comboState = GiftSendType.Active

-

Combo: 8 -> comboState = GiftSendType.Active

-

Combo: 12 -> comboState = GiftSendType.Finsihed

- - Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered + Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. ```java TikTokLive.newClient("host-name") -.onGiftCombo((liveClient, event) -> +.onLiveEnded((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java) + + + Triggers when a user follows the streamer. Based on social event. + + +```java +TikTokLive.newClient("host-name") +.onFollow((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokUnhandledSocialEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onUnhandledSocial((liveClient, event) -> { })