pawn.messages
Class InitiateChatResponseMessage

java.lang.Object
  |
  +--pawn.messages.InitiateChatResponseMessage

Direct Known Subclasses:

InitiateChatResponse

public abstract class InitiateChatResponseMessage

extends java.lang.Object

An abstract class defining a response to a request to begin a chat session. This response is responsible for sending a pipe advertisement in response to a Initiate Chat Request Message to allow a remote peer to begin chatting with the local peer.

Constructor Summary

InitiateChatResponseMessage()

Method Summary

abstract net.jxta.document.Document	getDocument(net.jxta.document.MimeMediaType asMimeType) Returns a Document object containing the response's document tree.
java.lang.String	getEmailAddress() Retrieve the email address of the user associated with the local peer.
java.lang.String	getName() Retrieve the display name of the user associated with the local peer.
net.jxta.protocol.PipeAdvertisement	getPipeAdvertisement() Returns the pipe advertisement object a remote peer can use to initiate the chat session.
void	setEmailAddress(java.lang.String emailAddress) Sets the email address of the user associated with the local peer.
void	setName(java.lang.String name) Sets the display name of the user associated with the local peer.
void	setPipeAdvertisement(net.jxta.protocol.PipeAdvertisement pipeAdvertisement) Sets the pipe advertisement object a remote peer can use to initiate the chat session.

Methods inherited from class java.lang.Object

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

Constructor Detail

InitiateChatResponseMessage

public InitiateChatResponseMessage()

Method Detail

getDocument

public abstract net.jxta.document.Document getDocument(net.jxta.document.MimeMediaType asMimeType)

Returns a Document object containing the response's document tree.

Parameters:

asMimeType - the desired MIME type for the response rendering.

Returns:

the Document containing the response's document object tree.

getEmailAddress

public java.lang.String getEmailAddress()

Retrieve the email address of the user associated with the local peer.

Returns:

the email address used to identify the user.

getName

public java.lang.String getName()

Retrieve the display name of the user associated with the local peer.

Returns:

the display name used to identify the user during the chat session.

getPipeAdvertisement

public net.jxta.protocol.PipeAdvertisement getPipeAdvertisement()

Returns the pipe advertisement object a remote peer can use to initiate the chat session.

Returns:

the pipe advertisement to use for setting up the chat session.

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

Sets the email address of the user associated with the local peer.

Parameters:

emailAddress - the email address used to identify the user.

setName

public void setName(java.lang.String name)

Sets the display name of the user associated with the local peer.

Parameters:

name - the display name used to identify the user during the chat session.

setPipeAdvertisement

public void setPipeAdvertisement(net.jxta.protocol.PipeAdvertisement pipeAdvertisement)

Sets the pipe advertisement object a remote peer can use to initiate the chat session.

Parameters:

pipeAdvertisement - the pipe advertisement to use for setting up the chat session.