messageevent.html

开源项目smack的API文件

public boolean <B>isCancelled</B>()</PRE>
<DL>
<DD>When the message is a notification returns if the receiver of the message cancelled 
 composing a reply.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the receiver of the message cancelled composing a reply</DL>
</DD>
</DL>
<HR>

<A NAME="getPacketID()"><!-- --></A><H3>
getPacketID</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getPacketID</B>()</PRE>
<DL>
<DD>Returns the unique ID of the message that requested to be notified of the event.
 The packet id is not used when the message is a request for notifications
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the message id that requested to be notified of the event.</DL>
</DD>
</DL>
<HR>

<A NAME="getEventTypes()"><!-- --></A><H3>
getEventTypes</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A> <B>getEventTypes</B>()</PRE>
<DL>
<DD>Returns the types of events. The type of event could be:
 "offline", "composing","delivered","displayed", "offline"
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an iterator over all the types of events of the MessageEvent.</DL>
</DD>
</DL>
<HR>

<A NAME="setComposing(boolean)"><!-- --></A><H3>
setComposing</H3>
<PRE>
public void <B>setComposing</B>(boolean&nbsp;composing)</PRE>
<DL>
<DD>When the message is a request sets if the sender of the message requests to be notified
 when the receiver is composing a reply.
 When the message is a notification sets if the receiver of the message is composing a 
 reply.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>composing</CODE> - sets if the sender is requesting to be notified when composing or when 
 notifying that the receiver of the message is composing a reply</DL>
</DD>
</DL>
<HR>

<A NAME="setDelivered(boolean)"><!-- --></A><H3>
setDelivered</H3>
<PRE>
public void <B>setDelivered</B>(boolean&nbsp;delivered)</PRE>
<DL>
<DD>When the message is a request sets if the sender of the message requests to be notified
 when the message is delivered.
 When the message is a notification sets if the message was delivered or not.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>delivered</CODE> - sets if the sender is requesting to be notified when delivered or when 
 notifying that the message was delivered</DL>
</DD>
</DL>
<HR>

<A NAME="setDisplayed(boolean)"><!-- --></A><H3>
setDisplayed</H3>
<PRE>
public void <B>setDisplayed</B>(boolean&nbsp;displayed)</PRE>
<DL>
<DD>When the message is a request sets if the sender of the message requests to be notified
 when the message is displayed.
 When the message is a notification sets if the message was displayed or not.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>displayed</CODE> - sets if the sender is requesting to be notified when displayed or when 
 notifying that the message was displayed</DL>
</DD>
</DL>
<HR>

<A NAME="setOffline(boolean)"><!-- --></A><H3>
setOffline</H3>
<PRE>
public void <B>setOffline</B>(boolean&nbsp;offline)</PRE>
<DL>
<DD>When the message is a request sets if the sender of the message requests to be notified
 when the receiver of the message is offline.
 When the message is a notification sets if the receiver of the message was offline.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>offline</CODE> - sets if the sender is requesting to be notified when offline or when 
 notifying that the receiver of the message is offline</DL>
</DD>
</DL>
<HR>

<A NAME="setCancelled(boolean)"><!-- --></A><H3>
setCancelled</H3>
<PRE>
public void <B>setCancelled</B>(boolean&nbsp;cancelled)</PRE>
<DL>
<DD>When the message is a notification sets if the receiver of the message cancelled 
 composing a reply.
 The Cancelled event is never requested explicitly. It is requested implicitly when
 requesting to be notified of the Composing event.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cancelled</CODE> - sets if the receiver of the message cancelled composing a reply</DL>
</DD>
</DL>
<HR>

<A NAME="setPacketID(java.lang.String)"><!-- --></A><H3>
setPacketID</H3>
<PRE>
public void <B>setPacketID</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;packetID)</PRE>
<DL>
<DD>Sets the unique ID of the message that requested to be notified of the event.
 The packet id is not used when the message is a request for notifications
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packetID</CODE> - the message id that requested to be notified of the event.</DL>
</DD>
</DL>
<HR>

<A NAME="isMessageEventRequest()"><!-- --></A><H3>
isMessageEventRequest</H3>
<PRE>
public boolean <B>isMessageEventRequest</B>()</PRE>
<DL>
<DD>Returns true if this MessageEvent is a request for notifications.
 Returns false if this MessageEvent is a notification of an event.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if this message is a request for notifications.</DL>
</DD>
</DL>
<HR>

<A NAME="toXML()"><!-- --></A><H3>
toXML</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toXML</B>()</PRE>
<DL>
<DD>Returns the XML representation of a Message Event according the specification.
 
 Usually the XML representation will be inside of a Message XML representation like
 in the following examples:<p>
 
 Request to be notified when displayed:
 <pre>
 &lt;message
    to='[e-mail]/orchard'
    from='[e-mail]/balcony'
    id='message22'&gt;
 &lt;x xmlns='jabber:x:event'&gt;
   &lt;displayed/&gt;
 &lt;/x&gt;
 &lt;/message&gt;
 </pre>
 
 Notification of displayed:
 <pre>
 &lt;message
    from='[e-mail]/orchard'
    to='[e-mail]/balcony'&gt;
 &lt;x xmlns='jabber:x:event'&gt;
   &lt;displayed/&gt;
   &lt;id&gt;message22&lt;/id&gt;
 &lt;/x&gt;
 &lt;/message&gt;
 </pre>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/smack/packet/PacketExtension.html#toXML()">toXML</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/smack/packet/PacketExtension.html" title="interface in org.jivesoftware.smack.packet">PacketExtension</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the packet extension as XML.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Smack</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/jivesoftware/smackx/packet/LastActivity.Provider.html" title="class in org.jivesoftware.smackx.packet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/smackx/packet/MUCAdmin.html" title="class in org.jivesoftware.smackx.packet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/smackx/packet/MessageEvent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="MessageEvent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2007 Jive Software. </i>
</BODY>
</HTML>