Kient Class
The entry class into Kient, provides access to Kick's API endpoints and WebSocket via ease to consume functions.
Properties
authenticated
Returns
boolean
Methods
static async create()
Creates a new Kient instance and returns it.
Returns
Promise<Kient>
Getters
api()
Returns available endpoints to consume.
| Endpoint | Reference |
|---|---|
| Authentication | AuthenticationEndpoint |
| Channels | ChannelEndpoint |
| Chat | ChatEndpoint |
| Clips | ClipEndpoint |
Returns
Endpoints
ws()
Returns available WebSockets to consume.
| Socket | Reference |
|---|---|
| chatroom | ChatroomSocket |
| channel | ChannelSocket |
| privateChatroom | PrivateChatroomSocket |
| privateChannel | PrivateChannelSocket |
| privateLivestream | PrivateLivestreamSocket |
Returns
WsHandlers
Events
Core
Events emitted in relation to core functionality or, not emitted by a socket (sometimes).
WebSocketConnected
Emitted once Kient has a connection to Kick's Pusher instance.
Emits
() => void
WebSocketDisconnected
Emitted once Kient has disconnected from Kick's Pusher instance.
Emits
() => void
UnknownEvent
Emitted from sockets when they receive an event which isn't tracked by Kient. Data emitted is of any type but mostly comes in the form of { eventName: string, data: any }.
Emits
(data: any) => void
Channel
Events emitted in relation to channels.
FollowersUpdate
Emits
(followersUpdateInstance: FollowersUpdateInstance) => void
Subscription
Emits
(channelSubscriptionInstance: ChannelSubscriptionInstance) => void
SubscriptionsGifted
Emits
(luckyUsersWhoGotGiftSubscriptionsInstance: LuckyUsersWhoGotGiftSubscriptionsInstance) => void
LeaderboardUpdate
Emits
(giftsLeaderboardUpdatedInstance: GiftsLeaderboardUpdatedInstance) => void
StartHost
Emits
(chatMoveToSupportedChannelInstance: ChatMoveToSupportedChannelInstance) => void
StartStream
Emits
(streamerIsLiveInstance: StreamerIsLiveInstance) => void
StopStream
Emits
(stopStreamBroadcastInstance: StopStreamBroadcastInstance) => void
Banned
Emits
(channelId: string | number) => void
Chatroom
Events emitted in relation to chatrooms.
Message
Emits
(chatMessageInstance: ChatMessageInstance) => void
MessageDeleted
Emits
(messageDeletedInstance: MessageDeletedInstance) => void
UserBanned
Emits
(bannedUserInstance: BannedUserInstance) => void
UserUnbanned
Emits
(unbannedUserInstance: UnbannedUserInstance) => void
MessagePinned
Emits
(pinnedMessageInstance: PinnedMessageInstance) => void
MessageUnpinned
Emits
(chatroomId: string | number) => void
Subscription
Emits
(subscriptionInstance: SubscriptionInstance) => void
SubscriptionsGifted
Emits
(giftedSubscriptionsInstance: GiftedSubscriptionsInstance) => void
PollUpdated
Emits
(pollInstance: PollUpdateInstance) => void
PollDeleted
Emits
(chatroomId: string | number) => void
SettingsUpdated
Emits
(chatroomInstance: ChatroomUpdatedInstance) => void
ClearChat
Emits
(chatroomClearInstance: ChatroomClearInstance) => void
Hosted
Emits
(hostedInstance: StreamHostInstance) => void
Private Channel
Events emitted in relation to private channels.
Subscription
Emits
(subscriptionCreatedInstance: SubscriptionCreatedInstance) => void
SubscriptionRenewed
Emits
(subscriptionRenewedInstance: SubscriptionRenewedInstance) => void
SubscriptionsGifted
Emits
(subscriptionGiftedInstance: SubscriptionGiftedInstance) => void
FollowerAdded
Emits
(followerAddedInstance: FollowerAddedInstance) => void
FollowerDeleted
Emits
(followerDeletedInstance: FollowerDeletedInstance) => void
Private Chatroom
Events emitted in relation to private channels.
BannedWordAdded
Emits
(bannedWordAddedInstance: BannedWordAddedInstance) => void
BannedWordDeleted
Emits
(bannedWordDeletedInstance: BannedWordDeletedInstance) => void
BannedUserAdded
Emits
(bannedUserAddedInstance: BannedUserAddedInstance) => void
BannedUserDeleted
Emits
(bannedUserDeletedInstance: BannedUserDeletedInstance) => void
EmotesOnlyModeActivated
Emits
(emotesModeActivatedInstance: EmotesModeActivatedInstance) => void
EmotesOnlyModeDeactivated
Emits
(emotesModeDeactivatedInstance: EmotesModeDeactivatedInstance) => void
FollowersOnlyModeActivated
Emits
(followersModeActivatedInstance: FollowersModeActivatedInstance) => void
FollowersOnlyModeDeactivated
Emits
(followersModeDeactivatedInstance: FollowersModeDeactivatedInstance) => void
SlowModeActivated
Emits
(slowModeActivatedInstance: SlowModeActivatedInstance) => void
SlowModeDeactivated
Emits
(slowModeDeactivatedInstance: SlowModeDeactivatedInstance) => void
SubscribersOnlyModeActivated
Emits
(subscribersModeActivatedInstance: SubscribersModeActivatedInstance) => void
SubscribersOnlyModeDeactivated
Emits
(subscribersModeDeactivatedInstance: SubscribersModeDeactivatedInstance) => void
UserTimedOut
Emits
(userTimeoutedInstance: UserTimeoutedInstance) => void
Private Livestream
Events emitted in relation to livestreams.
HostReceived
Emits
(hostReceivedInstance: HostReceivedInstance) => void
TitleChanged
Emits
(titleChangedInstance: TitleChangedInstance) => void
MatureModeActivated
Emits
(matureModeActivatedInstance: MatureModeActivatedInstance) => void
MatureModeDeactivated
Emits
(matureModeDeactivatedInstance: MatureModeDeactivatedInstance) => void
LivestreamInformationUpdated
Emits
(updatedLiveStreamInstance: UpdatedLiveStreamInstance) => void