roster.html

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

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="addItem(java.lang.String, org.xmpp.packet.Roster.Subscription)"><!-- --></A><H3>
addItem</H3>
<PRE>
public <A HREF="../../../org/xmpp/packet/Roster.Item.html" title="class in org.xmpp.packet">Roster.Item</A> <B>addItem</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;jid,
                           <A HREF="../../../org/xmpp/packet/Roster.Subscription.html" title="enum in org.xmpp.packet">Roster.Subscription</A>&nbsp;subscription)</PRE>
<DL>
<DD>Adds a new item to the roster. The name and groups are set to <tt>null</tt>
 If the roster packet already contains an item using the same JID, the
 information in the existing item will be overwritten with the new information.<p>

 The XMPP specification recommends that if the roster item is associated with another
 instant messaging user (human), that the JID be in bare form (e.g. user@domain).
 Use the <A HREF="../../../org/xmpp/packet/JID.html#toBareJID()"><CODE>toBareJID()</CODE></A> method for a bare JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the JID.<DD><CODE>subscription</CODE> - the subscription type.
<DT><B>Returns:</B><DD>the newly created item.</DL>
</DD>
</DL>
<HR>

<A NAME="addItem(org.xmpp.packet.JID, org.xmpp.packet.Roster.Subscription)"><!-- --></A><H3>
addItem</H3>
<PRE>
public <A HREF="../../../org/xmpp/packet/Roster.Item.html" title="class in org.xmpp.packet">Roster.Item</A> <B>addItem</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid,
                           <A HREF="../../../org/xmpp/packet/Roster.Subscription.html" title="enum in org.xmpp.packet">Roster.Subscription</A>&nbsp;subscription)</PRE>
<DL>
<DD>Adds a new item to the roster. The name and groups are set to <tt>null</tt>
 If the roster packet already contains an item using the same JID, the
 information in the existing item will be overwritten with the new information.<p>

 The XMPP specification recommends that if the roster item is associated with another
 instant messaging user (human), that the JID be in bare form (e.g. user@domain).
 Use the <A HREF="../../../org/xmpp/packet/JID.html#toBareJID()"><CODE>toBareJID()</CODE></A> method for a bare JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the JID.<DD><CODE>subscription</CODE> - the subscription type.
<DT><B>Returns:</B><DD>the newly created item.</DL>
</DD>
</DL>
<HR>

<A NAME="addItem(org.xmpp.packet.JID, java.lang.String, org.xmpp.packet.Roster.Ask, org.xmpp.packet.Roster.Subscription, java.util.Collection)"><!-- --></A><H3>
addItem</H3>
<PRE>
public <A HREF="../../../org/xmpp/packet/Roster.Item.html" title="class in org.xmpp.packet">Roster.Item</A> <B>addItem</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid,
                           <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="../../../org/xmpp/packet/Roster.Ask.html" title="enum in org.xmpp.packet">Roster.Ask</A>&nbsp;ask,
                           <A HREF="../../../org/xmpp/packet/Roster.Subscription.html" title="enum in org.xmpp.packet">Roster.Subscription</A>&nbsp;subscription,
                           <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<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>&gt;&nbsp;groups)</PRE>
<DL>
<DD>Adds a new item to the roster. If the roster packet already contains an item
 using the same JID, the information in the existing item will be overwritten
 with the new information.<p>

 The XMPP specification recommends that if the roster item is associated with another
 instant messaging user (human), that the JID be in bare form (e.g. user@domain).
 Use the <A HREF="../../../org/xmpp/packet/JID.html#toBareJID()"><CODE>toBareJID()</CODE></A> method for a bare JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the JID.<DD><CODE>name</CODE> - the nickname.<DD><CODE>ask</CODE> - the ask type.<DD><CODE>subscription</CODE> - the subscription type.<DD><CODE>groups</CODE> - a Collection of groups.
<DT><B>Returns:</B><DD>the newly created item.</DL>
</DD>
</DL>
<HR>

<A NAME="removeItem(org.xmpp.packet.JID)"><!-- --></A><H3>
removeItem</H3>
<PRE>
public void <B>removeItem</B>(<A HREF="../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;jid)</PRE>
<DL>
<DD>Removes an item from this roster.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the JID of the item to remove.</DL>
</DD>
</DL>
<HR>

<A NAME="getItems()"><!-- --></A><H3>
getItems</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../org/xmpp/packet/Roster.Item.html" title="class in org.xmpp.packet">Roster.Item</A>&gt; <B>getItems</B>()</PRE>
<DL>
<DD>Returns an unmodifiable copy of the <A HREF="../../../org/xmpp/packet/Roster.Item.html" title="class in org.xmpp.packet"><CODE>Items</CODE></A> in the roster packet.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an unmodifable copy of the <A HREF="../../../org/xmpp/packet/Roster.Item.html" title="class in org.xmpp.packet"><CODE>Items</CODE></A> in the roster packet.</DL>
</DD>
</DL>
<HR>

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

<DT><B>Returns:</B><DD>a deep copy of this Roster.</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/Presence.Type.html" title="enum in org.xmpp.packet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/xmpp/packet/Roster.Ask.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/Roster.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Roster.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>