presence.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

public <A HREF="../../../org/xmpp/packet/Presence.Show.html" title="enum in org.xmpp.packet">Presence.Show</A> <B>getShow</B>()</PRE>
<DL>
<DD>Returns the presence "show" value, which specifies a particular availability
 status. If the &lt;show&gt; element is not present, this method will return
 <tt>null</tt>. The show value can only be set if the presence type is "avaialble".
 A <tt>null</tt> show value is used to represent "available", which is the
 default.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the presence show value..<DT><B>See Also:</B><DD><A HREF="../../../org/xmpp/packet/Presence.Show.html" title="enum in org.xmpp.packet"><CODE>Presence.Show</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setShow(org.xmpp.packet.Presence.Show)"><!-- --></A><H3>
setShow</H3>
<PRE>
public void <B>setShow</B>(<A HREF="../../../org/xmpp/packet/Presence.Show.html" title="enum in org.xmpp.packet">Presence.Show</A>&nbsp;show)</PRE>
<DL>
<DD>Sets the presence "show" value, which specifies a particular availability
 status. The show value can only be set if the presence type is "available".
 A <tt>null</tt> show value is used to represent "available", which is the
 default.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>show</CODE> - the presence show value.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the presence type is not available.<DT><B>See Also:</B><DD><A HREF="../../../org/xmpp/packet/Presence.Show.html" title="enum in org.xmpp.packet"><CODE>Presence.Show</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getStatus()"><!-- --></A><H3>
getStatus</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getStatus</B>()</PRE>
<DL>
<DD>Returns the status of this presence packet, a natural-language description
 of availability status.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the status.</DL>
</DD>
</DL>
<HR>

<A NAME="setStatus(java.lang.String)"><!-- --></A><H3>
setStatus</H3>
<PRE>
public void <B>setStatus</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;status)</PRE>
<DL>
<DD>Sets the status of this presence packet, a natural-language description
 of availability status.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>status</CODE> - the status.</DL>
</DD>
</DL>
<HR>

<A NAME="getPriority()"><!-- --></A><H3>
getPriority</H3>
<PRE>
public int <B>getPriority</B>()</PRE>
<DL>
<DD>Returns the priority. The valid priority range is -128 through 128.
 If no priority element exists in the packet, this method will return
 the default value of 0.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the priority.</DL>
</DD>
</DL>
<HR>

<A NAME="setPriority(int)"><!-- --></A><H3>
setPriority</H3>
<PRE>
public void <B>setPriority</B>(int&nbsp;priority)</PRE>
<DL>
<DD>Sets the priority. The valid priority range is -128 through 128.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>priority</CODE> - the priority.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the priority is less than -128 or greater
      than 128.</DL>
</DD>
</DL>
<HR>

<A NAME="getChildElement(java.lang.String, java.lang.String)"><!-- --></A><H3>
getChildElement</H3>
<PRE>
public org.dom4j.Element <B>getChildElement</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;namespace)</PRE>
<DL>
<DD>Returns the first child element of this packet that matches the
 given name and namespace. If no matching element is found,
 <tt>null</tt> will be returned. This is a convenience method to avoid
 manipulating this underlying packet's Element instance directly.<p>

 Child elements in extended namespaces are used to extend the features
 of XMPP. Examples include a "user is typing" indicator and invitations to
 group chat rooms. Although any valid XML can be included in a child element
 in an extended namespace, many common features have been standardized
 as <a href="http://www.jabber.org/jeps">Jabber Enhancement Proposals</a>
 (JEPs).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the element name.<DD><CODE>namespace</CODE> - the element namespace.
<DT><B>Returns:</B><DD>the first matching child element, or <tt>null</tt> if there
      is no matching child element.</DL>
</DD>
</DL>
<HR>

<A NAME="addChildElement(java.lang.String, java.lang.String)"><!-- --></A><H3>
addChildElement</H3>
<PRE>
public org.dom4j.Element <B>addChildElement</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;namespace)</PRE>
<DL>
<DD>Adds a new child element to this packet with the given name and
 namespace. The newly created Element is returned. This is a
 convenience method to avoid manipulating this underlying packet's
 Element instance directly.<p>

 Child elements in extended namespaces are used to extend the features
 of XMPP. Examples include a "user is typing" indicator and invitations to
 group chat rooms. Although any valid XML can be included in a child element
 in an extended namespace, many common features have been standardized
 as <a href="http://www.jabber.org/jeps">Jabber Enhancement Proposals</a>
 (JEPs).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the element name.<DD><CODE>namespace</CODE> - the element namespace.
<DT><B>Returns:</B><DD>the newly created child element.</DL>
</DD>
</DL>
<HR>

<A NAME="createCopy()"><!-- --></A><H3>
createCopy</H3>
<PRE>
public <A HREF="../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A> <B>createCopy</B>()</PRE>
<DL>
<DD>Returns a deep copy of this Presence.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/xmpp/packet/Packet.html#createCopy()">createCopy</A></CODE> in class <CODE><A HREF="../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a deep copy of this Presence.</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>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/xmpp/packet/PacketExtension.html" title="class in org.xmpp.packet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/xmpp/packet/Presence.Show.html" title="enum in org.xmpp.packet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/xmpp/packet/Presence.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Presence.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.xmpp.packet.Packet">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;FIELD&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-2008 Jive Software.</i>
</BODY>
</HTML>