com.twilio.sync

Interface SyncStream

public interface SyncStream

SyncStream is an ordered message delivery queue.

You can publish messages and listen for incoming messages.

To obtain an instance of a SyncStream use SyncClient.openStream(com.twilio.sync.SyncOptions, com.twilio.sync.SyncStreamObserver, com.twilio.sync.SuccessListener<com.twilio.sync.SyncStream>).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SyncStream.Message Single message in a SyncStream.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITE_DURATION Time to live for a stream, specifying no expiry.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSid() An immutable system-assigned identifier of this Message SyncStream.
java.lang.String	getUniqueName() An optional unique name for this stream, assigned at creation time.
void	publishMessage(org.json.JSONObject data, SuccessListener<java.lang.String> listener) Publish a new message to this message stream.
void	removeStream(SuccessListener<java.lang.Void> listener) Remove the stream from the system, deleting it.
void	setTtl(int ttl, SuccessListener<java.lang.Void> listener) Set time to live for stream object in seconds.

Field Detail

INFINITE_DURATION

static final int INFINITE_DURATION

Time to live for a stream, specifying no expiry.

See Also:

Constant Field Values

Method Detail

getSid

java.lang.String getSid()

An immutable system-assigned identifier of this Message SyncStream.

Returns:

A string containing Message SyncStream SID.

getUniqueName

java.lang.String getUniqueName()

An optional unique name for this stream, assigned at creation time.

Returns:

The unique name.

publishMessage

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

Publish a new message to this message stream.

Parameters:

data - Contains the payload of the dispatched message. Maximum size in serialized JSON: 4KB.

listener - Async result listener. See SuccessListener.

setTtl

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

Set time to live for stream object in seconds.

This TTL specifies the minimum time the SyncStream will live, sometime soon after this time the object will be deleted.

If time to live is not specified, object lives infinitely long.

TTL could be used in order to auto-recycle old unused objects, but it is not recommended to build some app logic like timers using ttl.

Parameters:

ttl - Time to live in seconds from now or INFINITE_DURATION to indicate no expiry.

listener - Async result listener. See SuccessListener.

removeStream

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

Remove the stream from the system, deleting it.

Parameters:

listener - Async result listener. See SuccessListener.