penicillin/blue.starry.penicillin.endpoints.stream/filter

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>
Content copied to clipboard

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.

Twitter API reference

Receiver

Stream endpoint instance.

Return

StreamApiAction for FilterStreamHandler handler with FilterStreamListener listener.

Parameters

follow

A comma separated list of user IDs, indicating the users to return statuses for in the stream. See follow for more information.

track

Keywords to track. Phrases of keywords are specified by a comma-separated list. See track for more information.

locations

Specifies a set of bounding boxes to track. See locations for more information.

delimited

Specifies whether messages should be length-delimited. See delimited or more information.

stallWarnings

Specifies whether stall warnings should be delivered. See stall_warnings for more information.

language

Not documented yet.

options

Optional. Custom parameters of this request.