org.glassfish.cafe.api
Interface MessageIndication

All Superinterfaces:

Message

public interface MessageIndication
extends Message

Represents the Message Indication (like typing) in a chat between participants.

Author:

binod

See Also:

Chat

Nested Class Summary

static class

MessageIndication.State The State in the MessageIndication.

Method Summary

Date	getLastActive() Return the time when the participant was active previously in the chat.
String	getNextMessageType() Returns the content type of the next message participant is planning to send.
int	getRefreshInterval() Return the refresh interval time.
MessageIndication.State	getState() Return the state in the message indication.
void	setLastActive(Date lastActive) Set the time participant was active previously in the chat.
void	setNextMessageType(String msgType) Set the content type of the next message.
void	setRefreshInterval(int interval) Set the refresh interval time.
void	setState(MessageIndication.State st) Set the state in the message indication.

Methods inherited from interface org.glassfish.cafe.api.Message

consume, getContent, getContentType, reject, send, send, send

Method Detail

getState

MessageIndication.State getState()

Return the state in the message indication.

Returns:

State of the MessageIndication.

See Also:

MessageIndication.State

setState

void setState(MessageIndication.State st)

Set the state in the message indication.

Parameters:

st - State of the MessageIndication.

See Also:

MessageIndication.State

getNextMessageType

String getNextMessageType()

Returns the content type of the next message participant is planning to send.

Returns:

String

setNextMessageType

void setNextMessageType(String msgType)

Set the content type of the next message. For example, for plain text messages the type will be "plain/text".

Parameters:

msgType - Type of the next message.

getLastActive

Date getLastActive()

Return the time when the participant was active previously in the chat.

Returns:

Time when the participant was previously active.

See Also:

Date

setLastActive

void setLastActive(Date lastActive)

Set the time participant was active previously in the chat.

Parameters:

lastActive - Time when the participant was previously active.

getRefreshInterval

int getRefreshInterval()

Return the refresh interval time. Determines how often state is notified.

Returns:

Refresh interval in seconds.

setRefreshInterval

void setRefreshInterval(int interval)

Set the refresh interval time. Determines how often state is notified.

Parameters:

interval - Refresh interval in seconds.