rocks.xmpp.extensions.rtt

Class OutboundRealTimeMessage

java.lang.Object

rocks.xmpp.extensions.rtt.OutboundRealTimeMessage

public final class OutboundRealTimeMessage
extends Object

An outbound real-time message.

Method Summary

Modifier and Type	Method and Description
Message	commit() Commits the real-time message.
String	getId()
long	getRefreshInterval() Gets the refresh interval, after which a refresh message is sent to ensure real-time text is kept in sync.
int	getSequence() Gets the sequence number of this real-time message.
String	getText() Gets the current text.
long	getTransmissionInterval() Gets the transmission interval of real-time text.
boolean	isActive() Indicates whether this real-time message is active.
boolean	isComplete() Indicates whether this real-time message is complete.
void	reset() Sends a message refresh.
void	reset(String id, String text) Sends a message refresh, if you want to switch the message, which is being edited.
String	toString()
void	update(String text) Updates the text.

Methods inherited from class java.lang.Object

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

Method Detail

update

public final void update(String text)

Updates the text. The passed text is the complete text of the text field / text area. Action elements are computed automatically and are sent to the recipient.

Parameters:

text - The text.

reset

public final void reset()

Sends a message refresh. A new sequence id is generated and the current text is sent. This method is usually called automatically in during the refresh interval.

See Also:

4.7.3 Message Refresh

reset

public final void reset(String id,
                        String text)

Sends a message refresh, if you want to switch the message, which is being edited. Use this method, if you are composing a new message and want to switch to another (previous) message.

Parameters:

id - The message id for the message which is edited.

text - The text to reset this message to.

See Also:

7.5.3 Usage with Last Message Correction

getText

public final String getText()

Gets the current text.

Returns:

The text.

commit

public final Message commit()

Commits the real-time message.

Returns:

The final message.

getRefreshInterval

public final long getRefreshInterval()

Gets the refresh interval, after which a refresh message is sent to ensure real-time text is kept in sync. The default is 10 seconds.

Returns:

The refresh interval.

See Also:

4.7.3 Message Refresh

getTransmissionInterval

public final long getTransmissionInterval()

Gets the transmission interval of real-time text. The default is 700 milliseconds.

Returns:

The refresh interval.

See Also:

4.5 Transmission Interval

isComplete

public final boolean isComplete()

Indicates whether this real-time message is complete.

Returns:

True, if the message is complete.

isActive

public final boolean isActive()

Indicates whether this real-time message is active.

Returns:

True, if the message is active.

getSequence

public final int getSequence()

Gets the sequence number of this real-time message.

Returns:

The sequence number.

getId

public final String getId()

toString

public final String toString()

Overrides:

toString in class Object