com.echomine.jabber.msg

Class TimeIQMessage

java.lang.Object

com.echomine.jabber.JabberMessage

com.echomine.jabber.JabberJDOMMessage

com.echomine.jabber.AbstractJabberMessage

com.echomine.jabber.JabberIQMessage

com.echomine.jabber.msg.TimeIQMessage

All Implemented Interfaces:

JabberCode, JabberMessageParsable

public class TimeIQMessage
extends JabberIQMessage
implements JabberCode

Submits and parses a Client Time message. The message will return the time of the recipient that you sent the message to. This message seems to only work with the server and not when you send it to a user (somehow not supported). Thus, current implementation will not allow you to create a message that contains your own time information to send to the server. When requesting time from a client is, the message will implement letting you set values.

Current Implementation: JEP-0090 1.0

Field Summary

Fields inherited from class com.echomine.jabber.JabberIQMessage

TYPE_GET, TYPE_RESULT, TYPE_SET

Fields inherited from class com.echomine.jabber.AbstractJabberMessage

TYPE_ERROR

Fields inherited from class com.echomine.jabber.JabberMessage

messageID

Fields inherited from interface com.echomine.jabber.JabberCode

MSG_CHAT, MSG_INIT, MSG_IQ, MSG_IQ_AGENTS, MSG_IQ_AUTH, MSG_IQ_BROWSE, MSG_IQ_DISCO_INFO, MSG_IQ_DISCO_ITEMS, MSG_IQ_GATEWAY, MSG_IQ_LAST, MSG_IQ_OOB, MSG_IQ_PRIVATE, MSG_IQ_REGISTER, MSG_IQ_ROSTER, MSG_IQ_SEARCH, MSG_IQ_TIME, MSG_IQ_VACATION, MSG_IQ_VCARD, MSG_IQ_VERSION, MSG_IQ_XMLRPC, MSG_PRESENCE, MSG_UNKNOWN, MSG_X_DATA, MSG_X_DELAY, MSG_X_EVENT, MSG_X_EXPIRE, MSG_X_OOB, MSG_X_PGP_ENCRYPTED, MSG_X_PGP_SIGNED, MSG_X_ROSTER, PARSER_CHAT, PARSER_IQ, PARSER_IQ_AGENTS, PARSER_IQ_AUTH, PARSER_IQ_BROWSE, PARSER_IQ_DISCO_INFO, PARSER_IQ_DISCO_ITEMS, PARSER_IQ_GATEWAY, PARSER_IQ_LAST, PARSER_IQ_OOB, PARSER_IQ_PRIVATE, PARSER_IQ_REGISTER, PARSER_IQ_ROSTER, PARSER_IQ_SEARCH, PARSER_IQ_TIME, PARSER_IQ_VACATION, PARSER_IQ_VCARD, PARSER_IQ_VERSION, PARSER_IQ_XMLRPC, PARSER_PRESENCE, PARSER_X_DATA, PARSER_X_DELAY, PARSER_X_EVENT, PARSER_X_EXPIRE, PARSER_X_OOB, PARSER_X_PGP_ENCRYPTED, PARSER_X_PGP_SIGNED, PARSER_X_ROSTER, XMLNS_CHAT, XMLNS_ERROR_STANZA, XMLNS_ERROR_STREAM, XMLNS_IQ, XMLNS_IQ_AGENTS, XMLNS_IQ_AUTH, XMLNS_IQ_BROWSE, XMLNS_IQ_DISCO_INFO, XMLNS_IQ_DISCO_ITEMS, XMLNS_IQ_GATEWAY, XMLNS_IQ_LAST, XMLNS_IQ_OOB, XMLNS_IQ_PRIVATE, XMLNS_IQ_REGISTER, XMLNS_IQ_ROSTER, XMLNS_IQ_SEARCH, XMLNS_IQ_TIME, XMLNS_IQ_VACATION, XMLNS_IQ_VCARD, XMLNS_IQ_VERSION, XMLNS_IQ_XMLRPC, XMLNS_PRESENCE, XMLNS_STREAM, XMLNS_X_DATA, XMLNS_X_DELAY, XMLNS_X_EVENT, XMLNS_X_EXPIRE, XMLNS_X_OOB, XMLNS_X_PGP_ENCRYPTED, XMLNS_X_PGP_SIGNED, XMLNS_X_ROSTER

Constructor Summary

Constructors

Constructor and Description
TimeIQMessage() defaults to iq type get
TimeIQMessage(java.lang.String type) this constructor is for messages with type.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDisplay() retrieve the time display in a preformatted string returned by the client.
int	getMessageType() the default message type is unknown.
java.util.Date	getTimeInLocal() a convenience method that gives you the client's current time in the your own time zone.
java.lang.String	getTimeZone() get the timezone that the client is in
java.lang.String	getUTC() return the UTC time string as returned by the client

Methods inherited from class com.echomine.jabber.AbstractJabberMessage

getErrorMessage, getFrom, getTo, getType, isError, parse, setErrorMessage, setFrom, setTo, setType

Methods inherited from class com.echomine.jabber.JabberJDOMMessage

encode, getDOM, getXMLOutputter, setMessageID, toString

Methods inherited from class com.echomine.jabber.JabberMessage

getMessageID, getReplyMessage, getTimeout, getXMessage, getXMessages, interrupt, isReplyRequired, isSendXMessages, isSynchronized, replyReceived, setReplyRequired, setSendXMessages, setSynchronized, setTimeout, setXMessage, setXMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeIQMessage

public TimeIQMessage(java.lang.String type)

this constructor is for messages with type.

TimeIQMessage

public TimeIQMessage()

defaults to iq type get

Method Detail

getTimeInLocal

public java.util.Date getTimeInLocal()

a convenience method that gives you the client's current time in the your own time zone. Thus, it takes the UTC time and applies your time zone. If you wish to get the client's local time, then either format the date yourself OR you can also call getDisplay() to retrieve the client-provided time string (which is in the client's time zone, not yours).

getUTC

public java.lang.String getUTC()

return the UTC time string as returned by the client

getTimeZone

public java.lang.String getTimeZone()

get the timezone that the client is in

getDisplay

public java.lang.String getDisplay()

retrieve the time display in a preformatted string returned by the client. The time is in local time of the client (ie. using client's time zone, not yours).

getMessageType

public int getMessageType()

Description copied from class: JabberJDOMMessage

the default message type is unknown. It doesn't mean that there is no type. It just means that there is no known message parser for this particular object.

Overrides:

getMessageType in class JabberIQMessage

Returns:

a message code that is unique to the message

See Also:

JabberCode