blue.starry.penicillin.endpoints.stream

StreamDelimitedBy

enum StreamDelimitedBy : Enum<StreamDelimitedBy> , EnumRequestParameter

Represents stream delimiter type.

UserStreamFilterLevel

enum UserStreamFilterLevel : Enum<UserStreamFilterLevel> , EnumRequestParameter

UserStream "filter_level" flags.

UserStreamReplies

enum UserStreamReplies : Enum<UserStreamReplies> , EnumRequestParameter

UserStream "replies" flags.

UserStreamWith

enum UserStreamWith : Enum<UserStreamWith> , EnumRequestParameter

UserStream "with" flags.

filter

fun Stream.filter( follow: List<Long>? = null, track: List<String>? = null, locations: List<Pair<Double, Double>>? = null, delimited: StreamDelimitedBy = StreamDelimitedBy.Default, stallWarnings: Boolean? = null, language: String? = null, vararg options: Option): StreamApiAction<FilterStreamListener, FilterStreamHandler>

Returns public statuses that match one or more filter predicates. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Both GET and POST requests are supported, but GET requests with too many parameters may cause the request to be rejected for excessive URL length. Use a POST request to avoid long URLs. The track, follow, and locations fields should be considered to be combined with an OR operator. track=foo&follow=1234 returns Tweets matching "foo" OR created by user 1234. The default access level allows up to 400 track keywords, 5,000 follow userids and 25 0.1-360 degree location boxes. If you need access to more rules and filtering tools, please apply for enterprise access.

sample

fun Stream.sample( delimited: StreamDelimitedBy = StreamDelimitedBy.Default, stallWarnings: Boolean? = null, language: String? = null, vararg options: Option): StreamApiAction<SampleStreamListener, SampleStreamHandler>

Returns a small random sample of all public statuses via a stream. The Tweets returned by the default access level are the same, so if two different clients connect to this endpoint, they will see the same Tweets.

user

~~fun~~ Stream.~~user~~( delimited: StreamDelimitedBy = StreamDelimitedBy.Default, stallWarnings: Boolean? = null, with: UserStreamWith = UserStreamWith.Default, replies: UserStreamReplies = UserStreamReplies.Default, track: List<String>? = null, filterLevel: UserStreamFilterLevel = UserStreamFilterLevel.Default, language: String? = null, follow: List<Long>? = null, locations: List<Pair<Double, Double>>? = null, count: Int? = null, includeFollowingsActivity: Boolean? = null, stringifyFriendIds: Boolean? = null, vararg options: Option): StreamApiAction<UserStreamListener, UserStreamHandler>

Returns realtime timeline.

sample

val Stream.sample: StreamApiAction<SampleStreamListener, SampleStreamHandler>

Shorthand property to Stream.sample.

Package blue.starry.penicillin.endpoints.stream

Types

Functions

Properties