org.springframework.social.twitter.api

Interface StreamingOperations

public interface StreamingOperations

Defines operations for working with Twitter's streaming API

Author:

Craig Walls

Method Summary

Methods

Modifier and Type	Method and Description
Stream	filter(FilterStreamParameters parameters, List<StreamListener> listeners) Monitor a filtered stream, given a set of listeners.
Stream	filter(String trackKeywords, List<StreamListener> listeners) Monitor a filtered stream, given a set of listeners.
Stream	firehose(int backfill, List<StreamListener> listeners) Monitor the firehose stream, given a set of listeners and a backfill value.
Stream	firehose(List<StreamListener> listeners) Monitor the firehose stream, given a set of listeners.
Stream	sample(List<StreamListener> listeners) Monitor the sample stream, given a set of listeners.
Stream	user(List<StreamListener> listeners)
Stream	user(UserStreamParameters parameters, List<StreamListener> listeners)

Method Detail

firehose

Stream firehose(List<StreamListener> listeners)

Monitor the firehose stream, given a set of listeners. Per the documentation at https://dev.twitter.com/docs/api/1.1/get/statuses/firehose, the firehose stream requires special permission.

Parameters:

listeners - the listeners to monitor the stream

Returns:

the firehose stream

firehose

Stream firehose(int backfill,
              List<StreamListener> listeners)

Monitor the firehose stream, given a set of listeners and a backfill value. In a reconnect scenario, the backfill parameter indicates how many messages to attempt to receive that may have been missed during the disconnect. The backfill count may be any value from 1 to 150000 or -1 to -150000. Positive backfill values will result in a live feed once the backfilled messages have been delivered. Negative backfill values will result in a disconnect once the backfilled messages have been delivered. Per the documentation at https://dev.twitter.com/docs/api/1.1/get/statuses/firehose, the firehose stream requires special permission.

Parameters:

backfill - the number of messages to backfill. Valid values 1 to 150000 or -1 to -150000.

listeners - the listeners to monitor the stream

Returns:

the firehose stream

sample

Stream sample(List<StreamListener> listeners)

Monitor the sample stream, given a set of listeners.

Parameters:

listeners - the listeners to monitor the stream

Returns:

the sample stream

filter

Stream filter(String trackKeywords,
            List<StreamListener> listeners)

Monitor a filtered stream, given a set of listeners.

Parameters:

trackKeywords - the terms to track in the stream

listeners - the listeners to monitor the stream

Returns:

the filtered stream

filter

Stream filter(FilterStreamParameters parameters,
            List<StreamListener> listeners)

Monitor a filtered stream, given a set of listeners.

Parameters:

parameters - the stream's filter parameters

listeners - the listeners to monitor the stream

Returns:

the filtered stream

user

Stream user(List<StreamListener> listeners)

user

Stream user(UserStreamParameters parameters,
          List<StreamListener> listeners)