pawn.messages
Class InitiateChatRequestMessage

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

Direct Known Subclasses:

InitiateChatRequest

public abstract class InitiateChatRequestMessage

extends java.lang.Object

An abstract class defining a request to begin a chat session. This request is responsible for sending information on a peer/user requesting a chat session, so that the recipient can use it to determine whether or not to send a response containing a pipe advertisement to use to start the chat session.

Constructor Summary

InitiateChatRequestMessage()

Method Summary

abstract net.jxta.document.Document	getDocument(net.jxta.document.MimeMediaType asMimeType) Returns a Document object containing the query'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.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

InitiateChatRequestMessage

public InitiateChatRequestMessage()

Method Detail

getDocument

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

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

Parameters:

asMimeType - the desired MIME type for the query rendering.

Returns:

the Document containing the query'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.

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.