nodesubscription.html

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

<DT><B>Returns:</B><DD>the Date at which a leased subscription will end or has ended. A value of
         <tt>null</tt> means that the subscription will never expire.</DL>
</DD>
</DL>
<HR>

<A NAME="isIncludingBody()"><!-- --></A><H3>
isIncludingBody</H3>
<PRE>
public boolean <B>isIncludingBody</B>()</PRE>
<DL>
<DD>Returns whether an entity wants to receive an XMPP message body in
 addition to the payload format.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true when an entity wants to receive an XMPP message body in
         addition to the payload format</DL>
</DD>
</DL>
<HR>

<A NAME="getPresenceStates()"><!-- --></A><H3>
getPresenceStates</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="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>getPresenceStates</B>()</PRE>
<DL>
<DD>The presence states for which an entity wants to receive notifications. When the owner
 is in any of the returned presence states then he is allowed to receive notifications.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the presence states for which an entity wants to receive notifications.
         (e.g. available, away, etc.)</DL>
</DD>
</DL>
<HR>

<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.Type.html" title="enum in org.jivesoftware.openfire.pubsub">NodeSubscription.Type</A> <B>getType</B>()</PRE>
<DL>
<DD>Returns if the owner has subscribed to receive notification of new items only
 or of new nodes only. When subscribed to a Leaf Node then only <tt>items</tt>
 is available.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>whether the owner has subscribed to receive notification of new items only
         or of new nodes only.</DL>
</DD>
</DL>
<HR>

<A NAME="getDepth()"><!-- --></A><H3>
getDepth</H3>
<PRE>
public int <B>getDepth</B>()</PRE>
<DL>
<DD>Returns 1 when the subscriber wants to receive notifications only from first-level
 children of the collection. A value of 0 means that the subscriber wants to receive
 notifications from all descendents.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>1 when the subscriber wants to receive notifications only from first-level
         children of the collection or 0 when notififying only from all descendents.</DL>
</DD>
</DL>
<HR>

<A NAME="getKeyword()"><!-- --></A><H3>
getKeyword</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>getKeyword</B>()</PRE>
<DL>
<DD>Returns the keyword that the event needs to match. When <tt>null</tt> all event
 are going to be notified to the subscriber.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the keyword that the event needs to match. When <tt>null</tt> all event
         are going to be notified to the subscriber.</DL>
</DD>
</DL>
<HR>

<A NAME="configure(org.xmpp.packet.IQ, org.xmpp.forms.DataForm)"><!-- --></A><H3>
configure</H3>
<PRE>
public void <B>configure</B>(<A HREF="../../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A>&nbsp;originalIQ,
                      <A HREF="../../../../org/xmpp/forms/DataForm.html" title="class in org.xmpp.forms">DataForm</A>&nbsp;options)</PRE>
<DL>
<DD>Configures the subscription based on the sent <A HREF="../../../../org/xmpp/forms/DataForm.html" title="class in org.xmpp.forms"><CODE>DataForm</CODE></A> included in the IQ
 packet sent by the subscriber. If the subscription was pending of configuration
 then the last published item is going to be sent to the subscriber.<p>

 The originalIQ parameter may be <tt>null</tt> when using this API internally. When no
 IQ packet was sent then no IQ result will be sent to the sender. The rest of the
 functionality is the same.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>originalIQ</CODE> - the IQ packet sent by the subscriber to configure his subscription or
        null when using this API internally.<DD><CODE>options</CODE> - the data form containing the new subscription configuration.</DL>
</DD>
</DL>
<HR>

<A NAME="getConfigurationForm()"><!-- --></A><H3>
getConfigurationForm</H3>
<PRE>
public <A HREF="../../../../org/xmpp/forms/DataForm.html" title="class in org.xmpp.forms">DataForm</A> <B>getConfigurationForm</B>()</PRE>
<DL>
<DD>Returns a data form with the subscription configuration. The data form can be used to
 edit the subscription configuration.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>data form used by the subscriber to edit the subscription configuration.</DL>
</DD>
</DL>
<HR>

<A NAME="canSendPublicationEvent(org.jivesoftware.openfire.pubsub.LeafNode, org.jivesoftware.openfire.pubsub.PublishedItem)"><!-- --></A><H3>
canSendPublicationEvent</H3>
<PRE>
public boolean <B>canSendPublicationEvent</B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/LeafNode.html" title="class in org.jivesoftware.openfire.pubsub">LeafNode</A>&nbsp;leafNode,
                                       <A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A>&nbsp;publishedItem)</PRE>
<DL>
<DD>Returns true if an event notification can be sent to the subscriber for the specified
 published item based on the subsription configuration and subscriber status.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>leafNode</CODE> - the node that received the publication.<DD><CODE>publishedItem</CODE> - the published item to send or null if the publication didn't
        contain an item.
<DT><B>Returns:</B><DD>true if an event notification can be sent to the subscriber for the specified
         published item.</DL>
</DD>
</DL>
<HR>

<A NAME="isActive()"><!-- --></A><H3>
isActive</H3>
<PRE>
public boolean <B>isActive</B>()</PRE>
<DL>
<DD>Returns true if the subscription is active. A subscription is considered active if it
 has not expired, it has been approved and configured.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the subscription is active.</DL>
</DD>
</DL>
<HR>

<A NAME="getAffiliate()"><!-- --></A><H3>
getAffiliate</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeAffiliate.html" title="class in org.jivesoftware.openfire.pubsub">NodeAffiliate</A> <B>getAffiliate</B>()</PRE>
<DL>
<DD>Returns the <A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeAffiliate.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>NodeAffiliate</CODE></A> that owns this subscription. Users that have a
 subscription with the node will ALWAYS have an affiliation even if the
 affiliation is of type <tt>none</tt>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the NodeAffiliate that owns this subscription.</DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</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>toString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="sendAuthorizationRequest(org.xmpp.packet.JID)"><!-- --></A><H3>
sendAuthorizationRequest</H3>
<PRE>
public void <B>sendAuthorizationRequest</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;owner)</PRE>
<DL>
<DD>Sends an request to authorize the pending subscription to the specified owner.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>owner</CODE> - the JID of the user that will get the authorization request.</DL>
</DD>
</DL>
<HR>

<A NAME="sendAuthorizationRequest()"><!-- --></A><H3>
sendAuthorizationRequest</H3>
<PRE>
public void <B>sendAuthorizationRequest</B>()</PRE>
<DL>
<DD>Sends an request to authorize the pending subscription to all owners. The first
 answer sent by a owner will be processed. Rest of the answers will be discarded.
<P>
<DD><DL>
</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/jivesoftware/openfire/pubsub/NodeAffiliate.Affiliation.html" title="enum in org.jivesoftware.openfire.pubsub"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/pubsub/NodeSubscription.State.html" title="enum in org.jivesoftware.openfire.pubsub"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/pubsub/NodeSubscription.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="NodeSubscription.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>