rosteritem.html

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

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the current nickname for the item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html#setRecvStatus(org.jivesoftware.openfire.roster.RosterItem.RecvType)">setRecvStatus</A></B>(<A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A>&nbsp;recvStatus)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the current recv status of the item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html#setSubStatus(org.jivesoftware.openfire.roster.RosterItem.SubType)">setSubStatus</A></B>(<A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A>&nbsp;subStatus)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the current subscription status of the item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html#writeExternal(java.io.ObjectOutput)">writeExternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/ObjectOutput.html" title="class or interface in java.io">ObjectOutput</A>&nbsp;out)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="SUB_REMOVE"><!-- --></A><H3>
SUB_REMOVE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A> <B>SUB_REMOVE</B></PRE>
<DL>
<DD><p>Indicates the roster item should be removed.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="SUB_NONE"><!-- --></A><H3>
SUB_NONE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A> <B>SUB_NONE</B></PRE>
<DL>
<DD><p>No subscription is established.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="SUB_TO"><!-- --></A><H3>
SUB_TO</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A> <B>SUB_TO</B></PRE>
<DL>
<DD><p>The roster owner has a subscription to the roster item's presence.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="SUB_FROM"><!-- --></A><H3>
SUB_FROM</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A> <B>SUB_FROM</B></PRE>
<DL>
<DD><p>The roster item has a subscription to the roster owner's presence.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="SUB_BOTH"><!-- --></A><H3>
SUB_BOTH</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A> <B>SUB_BOTH</B></PRE>
<DL>
<DD><p>The roster item and owner have a mutual subscription.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="ASK_NONE"><!-- --></A><H3>
ASK_NONE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A> <B>ASK_NONE</B></PRE>
<DL>
<DD><p>The roster item has no pending subscription requests.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="ASK_SUBSCRIBE"><!-- --></A><H3>
ASK_SUBSCRIBE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A> <B>ASK_SUBSCRIBE</B></PRE>
<DL>
<DD><p>The roster item has been asked for permission to subscribe to their presence
 but no response has been received.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="ASK_UNSUBSCRIBE"><!-- --></A><H3>
ASK_UNSUBSCRIBE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A> <B>ASK_UNSUBSCRIBE</B></PRE>
<DL>
<DD><p>The roster owner has asked to the roster item to unsubscribe from it's
 presence but has not received confirmation.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="RECV_NONE"><!-- --></A><H3>
RECV_NONE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A> <B>RECV_NONE</B></PRE>
<DL>
<DD><p>There are no subscriptions that have been received but not presented to the user.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="RECV_SUBSCRIBE"><!-- --></A><H3>
RECV_SUBSCRIBE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A> <B>RECV_SUBSCRIBE</B></PRE>
<DL>
<DD><p>The server has received a subscribe request, but has not forwarded it to the user.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="RECV_UNSUBSCRIBE"><!-- --></A><H3>
RECV_UNSUBSCRIBE</H3>
<PRE>
public static final <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A> <B>RECV_UNSUBSCRIBE</B></PRE>
<DL>
<DD><p>The server has received an unsubscribe request, but has not forwarded it to the user.</p>
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="recvStatus"><!-- --></A><H3>
recvStatus</H3>
<PRE>
protected <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.RecvType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.RecvType</A> <B>recvStatus</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="jid"><!-- --></A><H3>
jid</H3>
<PRE>
protected <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>jid</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="nickname"><!-- --></A><H3>
nickname</H3>
<PRE>
protected <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>nickname</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="groups"><!-- --></A><H3>
groups</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</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; <B>groups</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="sharedGroups"><!-- --></A><H3>
sharedGroups</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</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; <B>sharedGroups</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="invisibleSharedGroups"><!-- --></A><H3>
invisibleSharedGroups</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</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; <B>invisibleSharedGroups</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="subStatus"><!-- --></A><H3>
subStatus</H3>
<PRE>
protected <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.SubType</A> <B>subStatus</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="askStatus"><!-- --></A><H3>
askStatus</H3>
<PRE>
protected <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.AskType.html" title="class in org.jivesoftware.openfire.roster">RosterItem.AskType</A> <B>askStatus</B></PRE>
<DL>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_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">