org.sakaiproject.chat2.tool

Class ChatDelivery

java.lang.Object

org.sakaiproject.util.BaseDelivery

org.sakaiproject.chat2.tool.ChatDelivery

All Implemented Interfaces:

org.sakaiproject.courier.api.Delivery, org.sakaiproject.courier.api.Expirable

public class ChatDelivery
extends org.sakaiproject.util.BaseDelivery
implements org.sakaiproject.courier.api.Expirable

ChatDelivery is a Delivery that causes a chat message to be appended to a table of chat messages in the HTML element identified by the address and elementID.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sakaiproject.chat2.model.ChatManager	chatManager
protected boolean	m_beepOnDelivery
protected Object	m_message The message.
protected String	placementId

Fields inherited from class org.sakaiproject.util.BaseDelivery

m_address, m_elementId

Constructor Summary

Constructors

Constructor and Description
ChatDelivery(String address, String elementId, Object message, String placementId, boolean beepOnDelivery, org.sakaiproject.chat2.model.ChatManager chatManager) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
String	compose() Compose a javascript message for delivery to the browser client window.
boolean	equals(Object obj) Are these the same?
long	getCreated()
org.sakaiproject.chat2.model.ChatMessage	getMessage()
String	getMessageId()
int	getTtl()
void	setCreated(long created)
void	setMessage(Object message)
String	toString() Display.

Methods inherited from class org.sakaiproject.util.BaseDelivery

act, getAddress, getElement, hashCode, setAddress, setElement

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

m_message

protected Object m_message

The message. it could be a string id or the actual message.

chatManager

protected org.sakaiproject.chat2.model.ChatManager chatManager

m_beepOnDelivery

protected boolean m_beepOnDelivery

placementId

protected String placementId

Constructor Detail

ChatDelivery

public ChatDelivery(String address,
            String elementId,
            Object message,
            String placementId,
            boolean beepOnDelivery,
            org.sakaiproject.chat2.model.ChatManager chatManager)

Construct.

Parameters:

address - The address.

elementId - The elementId.

Method Detail

getMessage

public org.sakaiproject.chat2.model.ChatMessage getMessage()

setMessage

public void setMessage(Object message)

compose

public String compose()

Compose a javascript message for delivery to the browser client window. This function happens in the client connection thread instead of in the event notification thread

Specified by:

compose in interface org.sakaiproject.courier.api.Delivery

Overrides:

compose in class org.sakaiproject.util.BaseDelivery

Returns:

The javascript message to send to the browser client window.

toString

public String toString()

Display.

Overrides:

toString in class org.sakaiproject.util.BaseDelivery

getMessageId

public String getMessageId()

equals

public boolean equals(Object obj)

Are these the same?

Overrides:

equals in class org.sakaiproject.util.BaseDelivery

Returns:

true if obj is the same Delivery as this one.

getCreated

public long getCreated()

Specified by:

getCreated in interface org.sakaiproject.courier.api.Expirable

setCreated

public void setCreated(long created)

getTtl

public int getTtl()

Specified by:

getTtl in interface org.sakaiproject.courier.api.Expirable