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.

Twitter API reference

Receiver

Stream endpoint instance.

Return

StreamApiAction for SampleStreamHandler handler with SampleStreamListener listener.

Parameters

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.


Shorthand property to Stream.sample.

See also