penicillin/blue.starry.penicillin.core.streaming.listener/UserStreamListener

UserStreamListener

interface UserStreamListener : StreamListener

An event model interface for UserStreamHandler.

Functions

onAnyEvent

open suspend fun onAnyEvent(event: Stream.Event)

Called when any events are received.

onAnyJson

open suspend fun onAnyJson(json: JsonObject)

Called when any payloads are received.

onAnyListEvent

open suspend fun onAnyListEvent(event: Stream.ListEvent)

Called when any list events are received.

onAnyStatusEvent

open suspend fun onAnyStatusEvent(event: Stream.StatusEvent)

Called when any status events are received.

onAnyUserEvent

open suspend fun onAnyUserEvent(event: Stream.UserEvent)

Called when any user events are received.

onBlock

open suspend fun onBlock(event: Stream.UserEvent)

Called when a block event is received.

onConnect

open suspend fun onConnect()

Called when streaming is connected.

onDelete

open suspend fun onDelete(delete: Stream.Delete)

Called when a delete event is received.

onDirectMessage

open suspend fun onDirectMessage(message: DirectMessage)

Called when a direct message is received.

onDisconnect

open suspend fun onDisconnect(cause: Throwable?)

Called when streaming is disconnected.

onDisconnectMessage

open suspend fun onDisconnectMessage(disconnect: Stream.Disconnect)

Called when a disconnect-message event is received.

onFavorite

open suspend fun onFavorite(event: Stream.StatusEvent)

Called when a favorite event is received.

onFavoritedRetweet

open suspend fun onFavoritedRetweet(event: Stream.StatusEvent)

Called when a favorited-retweet event is received.

onFollow

open suspend fun onFollow(event: Stream.UserEvent)

Called when a follow event is received.

onFriends

open suspend fun onFriends(friends: Stream.Friends)

Called when a friends event is received.

onHeartbeat

open suspend fun onHeartbeat()

Called when streaming sends heartbeat.

onLength

open suspend fun onLength(length: Int)

Called when streaming sends length.

onLimit

open suspend fun onLimit(limit: Stream.Limit)

Called when a limit event is received.

onListCreated

open suspend fun onListCreated(event: Stream.ListEvent)

Called when a list-created event is received.

onListDestroyed

open suspend fun onListDestroyed(event: Stream.ListEvent)

Called when a list-destroyed event is received.

onListMemberAdded

open suspend fun onListMemberAdded(event: Stream.ListEvent)

Called when a list-member-added event is received.

onListMemberRemoved

open suspend fun onListMemberRemoved(event: Stream.ListEvent)

Called when a list-member-removed event is received.

onListUpdated

open suspend fun onListUpdated(event: Stream.ListEvent)

Called when a list-updated event is received.

onListUserSubscribed

open suspend fun onListUserSubscribed(event: Stream.ListEvent)

Called when a list-user-subscribed event is received.

onListUserUnsubscribed

open suspend fun onListUserUnsubscribed(event: Stream.ListEvent)

Called when a list-user-unsubscribed event is received.

onMute

open suspend fun onMute(event: Stream.UserEvent)

Called when a mute event is received.

onQuotedTweet

open suspend fun onQuotedTweet(event: Stream.StatusEvent)

Called when a quoted-tweet event is received.

onRawData

open suspend fun onRawData(data: String)

Called when any data are connected.

onRetweetedRetweet

open suspend fun onRetweetedRetweet(event: Stream.StatusEvent)

Called when a retweeted-retweet event is received.

onScrubGeo

open suspend fun onScrubGeo(scrubGeo: Stream.ScrubGeo)

Called when a scrub-geo event is received.

onStatus

open suspend fun onStatus(status: Status)

Called when a status is received.

onStatusWithheld

open suspend fun onStatusWithheld(withheld: Stream.StatusWithheld)

Called when a status-withheld event is received.

onUnblock

open suspend fun onUnblock(event: Stream.UserEvent)

Called when an unblock event is received.

onUnfavorite

open suspend fun onUnfavorite(event: Stream.StatusEvent)

Called when an unfavorite event is received.

onUnfollow

open suspend fun onUnfollow(event: Stream.UserEvent)

Called when an unfollow event is received.

onUnhandledJson

open suspend fun onUnhandledJson(json: JsonObject)

Called when unhandled payloads are detected.

onUnknownData

open suspend fun onUnknownData(data: String)

Called when unhandled data are detected.

onUnmute

open suspend fun onUnmute(event: Stream.UserEvent)

Called when an unmute event is received.

onUserUpdate

open suspend fun onUserUpdate(event: Stream.UserEvent)

Called when a user-update event is received.

onUserWithheld

open suspend fun onUserWithheld(withheld: Stream.UserWithheld)

Called when a user-withheld event is received.

onWarning

open suspend fun onWarning(warning: Stream.Warning)

Called when a warning event is received.