API reference generated from the sources and Javadoc of TikTokLiveJava 1.13.1-Release: every public type of the `API` and `Client` modules.
API reference generated from the sources and Javadoc of TikTokLiveJava 1.13.1-Release: every public type of the API and Client modules.
Packages
Section titled “Packages”io.github.jwdeveloper.tiktok.api.annotationsio.github.jwdeveloper.tiktok.api.data.dtoio.github.jwdeveloper.tiktok.api.data.eventsio.github.jwdeveloper.tiktok.api.data.events.commonio.github.jwdeveloper.tiktok.api.data.events.controlio.github.jwdeveloper.tiktok.api.data.events.envelopio.github.jwdeveloper.tiktok.api.data.events.giftio.github.jwdeveloper.tiktok.api.data.events.httpio.github.jwdeveloper.tiktok.api.data.events.linkio.github.jwdeveloper.tiktok.api.data.events.pollio.github.jwdeveloper.tiktok.api.data.events.roomio.github.jwdeveloper.tiktok.api.data.events.socialio.github.jwdeveloper.tiktok.api.data.events.websocketio.github.jwdeveloper.tiktok.api.data.modelsio.github.jwdeveloper.tiktok.api.data.models.badgesio.github.jwdeveloper.tiktok.api.data.models.barrageio.github.jwdeveloper.tiktok.api.data.models.battlesio.github.jwdeveloper.tiktok.api.data.models.chestio.github.jwdeveloper.tiktok.api.data.models.giftsio.github.jwdeveloper.tiktok.api.data.models.httpio.github.jwdeveloper.tiktok.api.data.models.usersio.github.jwdeveloper.tiktok.api.data.requestsio.github.jwdeveloper.tiktok.api.data.settingsio.github.jwdeveloper.tiktok.api.exceptionsio.github.jwdeveloper.tiktok.api.httpio.github.jwdeveloper.tiktok.api.listenerio.github.jwdeveloper.tiktok.api.liveio.github.jwdeveloper.tiktok.api.live.builderio.github.jwdeveloper.tiktok.api.mappersio.github.jwdeveloper.tiktok.api.mappers.dataio.github.jwdeveloper.tiktok.api.modelsio.github.jwdeveloper.tiktok.api.utilsio.github.jwdeveloper.tiktok.api.websocketio.github.jwdeveloper.tiktok.clientio.github.jwdeveloper.tiktok.client.commonio.github.jwdeveloper.tiktok.client.giftsio.github.jwdeveloper.tiktok.client.httpio.github.jwdeveloper.tiktok.client.http.mappersio.github.jwdeveloper.tiktok.client.listenerio.github.jwdeveloper.tiktok.client.mappersio.github.jwdeveloper.tiktok.client.mappers.handlersio.github.jwdeveloper.tiktok.client.websocketio.github.jwdeveloper.tiktok.client.websocket.euler
Classes
Section titled “Classes”ActionResult(io.github.jwdeveloper.tiktok.client.common)ActionResultBuilder(io.github.jwdeveloper.tiktok.client.common)AsyncHandler(io.github.jwdeveloper.tiktok.client.common)Badge(io.github.jwdeveloper.tiktok.api.data.models.badges)BarrageParam(io.github.jwdeveloper.tiktok.api.data.models.barrage)Chest(io.github.jwdeveloper.tiktok.api.data.models.chest)CombineBadge(io.github.jwdeveloper.tiktok.api.data.models.badges)ConsoleColors(io.github.jwdeveloper.tiktok.api.utils)Emote(io.github.jwdeveloper.tiktok.api.data.models)FansLevelParam(io.github.jwdeveloper.tiktok.api.data.models.barrage)Gift(io.github.jwdeveloper.tiktok.api.data.models.gifts)GiftsData(io.github.jwdeveloper.tiktok.api.data.requests)GiftsData.Response(io.github.jwdeveloper.tiktok.api.data.requests)GiftsDataMapper(io.github.jwdeveloper.tiktok.client.http.mappers)HttpClient(io.github.jwdeveloper.tiktok.client.http)HttpClientBuilder(io.github.jwdeveloper.tiktok.client.http)HttpClientFactory(io.github.jwdeveloper.tiktok.client.http)HttpClientSettings(io.github.jwdeveloper.tiktok.api.data.settings)HttpData(io.github.jwdeveloper.tiktok.api.data.models.http)HttpProxyClient(io.github.jwdeveloper.tiktok.client.http)HttpRequestJsonMapper(io.github.jwdeveloper.tiktok.client.http.mappers)HttpResponseJsonMapper(io.github.jwdeveloper.tiktok.client.http.mappers)JsonUtil(io.github.jwdeveloper.tiktok.api.utils)LinkMicArmy(io.github.jwdeveloper.tiktok.api.data.models)ListUser(io.github.jwdeveloper.tiktok.api.data.models.users)ListenerMethodInfo(io.github.jwdeveloper.tiktok.client.listener)LiveClientSettings(io.github.jwdeveloper.tiktok.api.data.settings)LiveConnectionData(io.github.jwdeveloper.tiktok.api.data.requests)LiveConnectionData.Request(io.github.jwdeveloper.tiktok.api.data.requests)LiveConnectionData.Response(io.github.jwdeveloper.tiktok.api.data.requests)LiveData(io.github.jwdeveloper.tiktok.api.data.requests)LiveData.Request(io.github.jwdeveloper.tiktok.api.data.requests)LiveData.Response(io.github.jwdeveloper.tiktok.api.data.requests)LiveDataMapper(io.github.jwdeveloper.tiktok.client.http.mappers)LiveUserData(io.github.jwdeveloper.tiktok.api.data.requests)LiveUserData.Request(io.github.jwdeveloper.tiktok.api.data.requests)LiveUserData.Response(io.github.jwdeveloper.tiktok.api.data.requests)LiveUserDataMapper(io.github.jwdeveloper.tiktok.client.http.mappers)LoggerFactory(io.github.jwdeveloper.tiktok.client.common)MappingResult(io.github.jwdeveloper.tiktok.api.mappers.data)MessageMetaData(io.github.jwdeveloper.tiktok.api.data.dto)MessagesMapperFactory(io.github.jwdeveloper.tiktok.client.mappers)Picture(io.github.jwdeveloper.tiktok.api.data.models)PictureBadge(io.github.jwdeveloper.tiktok.api.data.models.badges)PollOption(io.github.jwdeveloper.tiktok.api.data.models)ProtoBufferFileGenerator(io.github.jwdeveloper.tiktok.api.utils)ProtoBufferJsonGenerator(io.github.jwdeveloper.tiktok.api.utils)ProtoBufferObject(io.github.jwdeveloper.tiktok.api.utils)ProtoBufferObject.ProtoBufferField(io.github.jwdeveloper.tiktok.api.utils)ProtocolUtils(io.github.jwdeveloper.tiktok.api.utils)ProxyClientSettings(io.github.jwdeveloper.tiktok.api.data.settings)ProxyData(io.github.jwdeveloper.tiktok.api.data.dto)RankingUser(io.github.jwdeveloper.tiktok.api.data.models)SocialTypes(io.github.jwdeveloper.tiktok.api.models)Stopwatch(io.github.jwdeveloper.tiktok.api.utils)StringBadge(io.github.jwdeveloper.tiktok.api.data.models.badges)SubscribeGiftParam(io.github.jwdeveloper.tiktok.api.data.models.barrage)Team(io.github.jwdeveloper.tiktok.api.data.models.battles)Text(io.github.jwdeveloper.tiktok.api.data.models)Text.GiftTextPiece(io.github.jwdeveloper.tiktok.api.data.models)Text.StringTextPiece(io.github.jwdeveloper.tiktok.api.data.models)Text.TextPiece(io.github.jwdeveloper.tiktok.api.data.models)Text.UserTextPiece(io.github.jwdeveloper.tiktok.api.data.models)TextBadge(io.github.jwdeveloper.tiktok.api.data.models.badges)TikTokBarrageEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokCaptionEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokCaptionEvent.CaptionContent(io.github.jwdeveloper.tiktok.api.data.events)TikTokChestEvent(io.github.jwdeveloper.tiktok.api.data.events.envelop)TikTokCommentEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokCommonEventHandler(io.github.jwdeveloper.tiktok.client.mappers.handlers)TikTokConnectedEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokConnectingEvent(io.github.jwdeveloper.tiktok.api.data.events.control) — Triggered when client is connecting to live is successfully established.TikTokDetectEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokDisconnectedEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokEmoteEvent(io.github.jwdeveloper.tiktok.api.data.events) — Triggered every time a subscriber sends an emote (sticker).TikTokEmptyEvent(io.github.jwdeveloper.tiktok.api.data.events.common)TikTokEnvelopeEvent(io.github.jwdeveloper.tiktok.api.data.events) — Triggered every time someone sends a treasure chest.TikTokErrorEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokEvent(io.github.jwdeveloper.tiktok.api.data.events.common)TikTokEventListenerBase(io.github.jwdeveloper.tiktok.api.listener)TikTokEventListenerMethodException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokFollowEvent(io.github.jwdeveloper.tiktok.api.data.events.social)TikTokGenericEventMapper(io.github.jwdeveloper.tiktok.client.mappers) — Goal of this class is to map ProtocolBuffer objects to TikTok Event in generic wayTikTokGiftComboEvent(io.github.jwdeveloper.tiktok.api.data.events.gift)TikTokGiftEvent(io.github.jwdeveloper.tiktok.api.data.events.gift)TikTokGiftEventHandler(io.github.jwdeveloper.tiktok.client.mappers.handlers)TikTokGiftsManager(io.github.jwdeveloper.tiktok.client.gifts)TikTokGoalUpdateEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokHeaderEvent(io.github.jwdeveloper.tiktok.api.data.events.common)TikTokHttpResponseEvent(io.github.jwdeveloper.tiktok.api.data.events.http)TikTokIMDeleteEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokInRoomBannerEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokJoinEvent(io.github.jwdeveloper.tiktok.api.data.events.social)TikTokLikeEvent(io.github.jwdeveloper.tiktok.api.data.events.social)TikTokLinkAcceptNoticeEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkApplyEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkCancelEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkCloseEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkCohostListChangeEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkCreateEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkEnterEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkInviteEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkKickOutEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkLayerEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokLinkLeaveEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkLinkedListChangeEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkListChangeEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkMediaChangeEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkMicArmiesEvent(io.github.jwdeveloper.tiktok.api.data.events) — Triggered every time a battle participant receives points.TikTokLinkMicBattleEvent(io.github.jwdeveloper.tiktok.api.data.events) — Triggered every time a battle starts & endsTikTokLinkMicBattleItemCard(io.github.jwdeveloper.tiktok.api.data.events)TikTokLinkMicFanTicketEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokLinkMicIdxUpdateEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkMicMethodEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokLinkMuteEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkRandomMatchEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkReplyEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkSysKickOutEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkUpdateUserEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkUpdateUserSettingEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkUserToastEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokLinkWaitListChangeEvent(io.github.jwdeveloper.tiktok.api.data.events.link)TikTokListenersManager(io.github.jwdeveloper.tiktok.client.listener)TikTokLive(io.github.jwdeveloper.tiktok.client)TikTokLiveClient(io.github.jwdeveloper.tiktok.client)TikTokLiveClientBuilder(io.github.jwdeveloper.tiktok.client)TikTokLiveClientEvent(io.github.jwdeveloper.tiktok.api.data.events.common)TikTokLiveEndedEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokLiveEventHandler(io.github.jwdeveloper.tiktok.client)TikTokLiveException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokLiveHttpClient(io.github.jwdeveloper.tiktok.client)TikTokLiveHttpOfflineClient(io.github.jwdeveloper.tiktok.client)TikTokLiveMapper(io.github.jwdeveloper.tiktok.client.mappers)TikTokLiveMapperHelper(io.github.jwdeveloper.tiktok.client.mappers)TikTokLiveMapperModel(io.github.jwdeveloper.tiktok.client.mappers)TikTokLiveMessageException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokLiveMessageHandler(io.github.jwdeveloper.tiktok.client)TikTokLiveOfflineHostException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokLivePausedEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokLivePreConnectionException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokLiveRequestException(io.github.jwdeveloper.tiktok.api.exceptions) — Happens while bad response from Http request to TikTokTikTokLiveUnknownHostException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokLiveUnpausedEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokMessageMappingException(io.github.jwdeveloper.tiktok.api.exceptions) — Happens when incoming data from TikTok can not be mapped to TikTokEvent’sTikTokPollEndEvent(io.github.jwdeveloper.tiktok.api.data.events.poll)TikTokPollEvent(io.github.jwdeveloper.tiktok.api.data.events.poll)TikTokPollStartEvent(io.github.jwdeveloper.tiktok.api.data.events.poll)TikTokPollUpdateEvent(io.github.jwdeveloper.tiktok.api.data.events.poll)TikTokPreConnectionEvent(io.github.jwdeveloper.tiktok.api.data.events.control)TikTokProtocolBufferException(io.github.jwdeveloper.tiktok.api.exceptions) — Happens when incoming data from TikTok is invalidTikTokProxyRequestException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokQuestionEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokRankTextEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokRankUpdateEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokReconnectingEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokRoomInfo(io.github.jwdeveloper.tiktok.client)TikTokRoomInfoEvent(io.github.jwdeveloper.tiktok.api.data.events.room)TikTokRoomInfoEventHandler(io.github.jwdeveloper.tiktok.client.mappers.handlers)TikTokRoomPinEvent(io.github.jwdeveloper.tiktok.api.data.events.room)TikTokShareEvent(io.github.jwdeveloper.tiktok.api.data.events.social)TikTokShopEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokSignServerException(io.github.jwdeveloper.tiktok.api.exceptions)TikTokSocialMediaEventHandler(io.github.jwdeveloper.tiktok.client.mappers.handlers)TikTokSubNotifyEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokSubscribeEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokUnauthorizedMemberEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokUnhandledControlEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokUnhandledEvent(io.github.jwdeveloper.tiktok.api.data.events.common)TikTokUnhandledMemberEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokUnhandledSocialEvent(io.github.jwdeveloper.tiktok.api.data.events)TikTokWebSocketClient(io.github.jwdeveloper.tiktok.client.websocket)TikTokWebSocketEulerClient(io.github.jwdeveloper.tiktok.client.websocket.euler)TikTokWebSocketEulerListener(io.github.jwdeveloper.tiktok.client.websocket.euler)TikTokWebSocketListener(io.github.jwdeveloper.tiktok.client.websocket)TikTokWebSocketOfflineClient(io.github.jwdeveloper.tiktok.client.websocket)TikTokWebsocketMessageEvent(io.github.jwdeveloper.tiktok.api.data.events.websocket)TikTokWebsocketResponseEvent(io.github.jwdeveloper.tiktok.api.data.events.websocket)TikTokWebsocketUnhandledMessageEvent(io.github.jwdeveloper.tiktok.api.data.events.websocket)User(io.github.jwdeveloper.tiktok.api.data.models.users)UserGradeParam(io.github.jwdeveloper.tiktok.api.data.models.barrage)WebSocketHeartbeatTask(io.github.jwdeveloper.tiktok.client.websocket)
Interfaces
Section titled “Interfaces”AfterMappingAction(io.github.jwdeveloper.tiktok.api.mappers.data)EventConsumer(io.github.jwdeveloper.tiktok.api.live.builder)EventsBuilder(io.github.jwdeveloper.tiktok.api.live.builder)GiftsManager(io.github.jwdeveloper.tiktok.api.live)ListenersManager(io.github.jwdeveloper.tiktok.api.listener) — Manages a collection of event listener objects and their configuration.LiveClient(io.github.jwdeveloper.tiktok.api.live)LiveClientBuilder(io.github.jwdeveloper.tiktok.api.live.builder)LiveEventsHandler(io.github.jwdeveloper.tiktok.api.live)LiveHttpClient(io.github.jwdeveloper.tiktok.api.http)LiveMapper(io.github.jwdeveloper.tiktok.api.mappers)LiveMapperHelper(io.github.jwdeveloper.tiktok.api.mappers)LiveMessagesHandler(io.github.jwdeveloper.tiktok.api.live)LiveRoomInfo(io.github.jwdeveloper.tiktok.api.live)LiveSocketClient(io.github.jwdeveloper.tiktok.api.websocket)MappingAction(io.github.jwdeveloper.tiktok.api.mappers.data)TikTokMapperModel(io.github.jwdeveloper.tiktok.api.mappers)
ConnectionState(io.github.jwdeveloper.tiktok.api.models)EventType(io.github.jwdeveloper.tiktok.api.annotations)GiftComboStateType(io.github.jwdeveloper.tiktok.api.data.models.gifts)LiveClientStopType(io.github.jwdeveloper.tiktok.api.websocket)LiveData.LiveStatus(io.github.jwdeveloper.tiktok.api.data.requests)LiveData.LiveType(io.github.jwdeveloper.tiktok.api.data.requests)LiveUserData.UserStatus(io.github.jwdeveloper.tiktok.api.data.requests)Priority(io.github.jwdeveloper.tiktok.api.annotations) — ORDER - HIGHEST 1st, HIGH 2nd, NORMAL 3rd, LOW 4th, LOWEST 5thProxyClientSettings.Rotation(io.github.jwdeveloper.tiktok.api.data.settings)TikTokLinkKickOutEvent.KickOutReason(io.github.jwdeveloper.tiktok.api.data.events.link)UserAttribute(io.github.jwdeveloper.tiktok.api.data.models.users)
Annotations
Section titled “Annotations”EventMeta(io.github.jwdeveloper.tiktok.api.annotations)TikTokEventObserver(io.github.jwdeveloper.tiktok.api.annotations)