StreamingApi

interface StreamingApi

Listen to new statuses in real-time with the WebSockets API.

See also

Functions

Link copied to clipboard
abstract suspend fun getDirectMessageStream(): Flow<StreamingEvent>

Gets a real-time stream of all direct messages.

Link copied to clipboard
abstract suspend fun getHashtagLocalStream(tag: String): Flow<StreamingEvent>

Gets a real-time stream of new statuses on the instance's local timeline for the given tag.

Link copied to clipboard
abstract suspend fun getHashtagStream(tag: String): Flow<StreamingEvent>

Gets a real-time stream of new statuses on the federated timeline for the given tag.

Link copied to clipboard
abstract suspend fun getHomeStream(): Flow<StreamingEvent>

Gets a real-time stream of new statuses on the user's home timeline.

Link copied to clipboard
abstract suspend fun getListStream(listId: String): Flow<StreamingEvent>

Gets a real-time stream of new statuses for the given list.

Link copied to clipboard
abstract suspend fun getPublicLocalStream(): Flow<StreamingEvent>

Gets a real-time stream of new statuses on the instance's local timeline.

Link copied to clipboard
abstract suspend fun getPublicStream(): Flow<StreamingEvent>

Gets a real-time stream of new statuses on the federated public timeline.