com.twilio.sync

Class Stream

java.lang.Object

com.twilio.sync.Stream

public class Stream
extends java.lang.Object

Stream is an ordered message delivery queue.

You can publish messages and listen for incoming messages.

To obtain an instance of a Stream use SyncClient.openStream(com.twilio.sync.Options, com.twilio.sync.StreamObserver, com.twilio.sync.SuccessListener<com.twilio.sync.Stream>).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stream.Message Single message in a Stream.

Field Summary

Fields

Modifier and Type	Field and Description
int	InfiniteDuration Time to live for a document, specifying no expiry.

Method Summary

Modifier and Type	Method and Description
void	dispose()
java.lang.String	getSid()
java.lang.String	getUniqueName()
void	publishMessage(org.json.JSONObject data, SuccessListener<java.lang.String> listener)
void	removeStream(SuccessListener<java.lang.Void> listener)
void	setTtl(int ttl, SuccessListener<java.lang.Void> listener) Update the stream’s time to live.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

InfiniteDuration

public final int InfiniteDuration

Time to live for a document, specifying no expiry.

See Also:

Constant Field Values

Method Detail

getSid

public java.lang.String getSid()

getUniqueName

public java.lang.String getUniqueName()

publishMessage

public void publishMessage(org.json.JSONObject data,
                           SuccessListener<java.lang.String> listener)

setTtl

public void setTtl(int ttl,
                   SuccessListener<java.lang.Void> listener)

Update the stream’s time to live.

Parameters:

ttl - The new time to live for this stream in seconds from now or Stream.InfiniteDuration to indicate no expiry.

listener - Async result listener. See SuccessListener.

removeStream

public void removeStream(SuccessListener<java.lang.Void> listener)

dispose

public void dispose()