📄 pubsubservice.html
字号:
</TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItemTask.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItemTask</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getPublishedItemTask()">getPublishedItemTask</A></B>()</CODE><BR> Returns the published item task used for this service.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub">CollectionNode</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getRootCollectionNode()">getRootCollectionNode</A></B>()</CODE><BR> Returns the <A HREF="../../../../org/jivesoftware/openfire/pubsub/CollectionNode.html" title="class in org.jivesoftware.openfire.pubsub"><CODE>CollectionNode</CODE></A> that acts as the root node of the entire node hierarchy.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <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></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getServiceID()">getServiceID</A></B>()</CODE><BR> Returns a String that uniquely identifies this pubsub service.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <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><<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>></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getShowPresences(org.xmpp.packet.JID)">getShowPresences</A></B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> subscriber)</CODE><BR> Returns the show values of the last know presence of all connected resources of the specified subscriber.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Timer.html" title="class or interface in java.util">Timer</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#getTimer()">getTimer</A></B>()</CODE><BR> Returns the timer used for the maintenance process of this service.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isCollectionNodesSupported()">isCollectionNodesSupported</A></B>()</CODE><BR> Returns true if the pubsub service supports collection nodes.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isInstantNodeSupported()">isInstantNodeSupported</A></B>()</CODE><BR> Returns true if the pubsub service allows users to create nodes without specifying the node ID.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isMultipleSubscriptionsEnabled()">isMultipleSubscriptionsEnabled</A></B>()</CODE><BR> Returns true if a user may have more than one subscription with the node.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#isServiceAdmin(org.xmpp.packet.JID)">isServiceAdmin</A></B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> user)</CODE><BR> Returns true if the specified user is a sysadmin of the pubsub service or has admin privileges.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#presenceSubscriptionNotRequired(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)">presenceSubscriptionNotRequired</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A> node, <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> user)</CODE><BR> Requests the pubsub service to unsubscribe from the presence of the user.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#presenceSubscriptionRequired(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.JID)">presenceSubscriptionRequired</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A> node, <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> user)</CODE><BR> Requests the pubsub service to subscribe to the presence of the user.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#queueItemToAdd(org.jivesoftware.openfire.pubsub.PublishedItem)">queueItemToAdd</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A> newItem)</CODE><BR> Adds the item to the queue of items to add to the database.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#queueItemToRemove(org.jivesoftware.openfire.pubsub.PublishedItem)">queueItemToRemove</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItem.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItem</A> removedItem)</CODE><BR> Adds the item to the queue of items to remove from the database.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#removeNode(java.lang.String)">removeNode</A></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> nodeID)</CODE><BR> Removes the specified node from the service.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#send(org.xmpp.packet.Packet)">send</A></B>(<A HREF="../../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A> packet)</CODE><BR> Sends the specified packet.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#sendNotification(org.jivesoftware.openfire.pubsub.Node, org.xmpp.packet.Message, org.xmpp.packet.JID)">sendNotification</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/Node.html" title="class in org.jivesoftware.openfire.pubsub">Node</A> node, <A HREF="../../../../org/xmpp/packet/Message.html" title="class in org.xmpp.packet">Message</A> message, <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> jid)</CODE><BR> Sends the specified Message containing an event notification to a specific subscriber of the specified node.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#setItemsTaskTimeout(int)">setItemsTaskTimeout</A></B>(int timeout)</CODE><BR> Sets the timeout value for the published items maintenance task.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/pubsub/PubSubService.html#setPublishedItemTask(org.jivesoftware.openfire.pubsub.PublishedItemTask)">setPublishedItemTask</A></B>(<A HREF="../../../../org/jivesoftware/openfire/pubsub/PublishedItemTask.html" title="class in org.jivesoftware.openfire.pubsub">PublishedItemTask</A> task)</CODE><BR> Sets the published item task used for this service.</TD></TR></TABLE> <P><!-- ============ METHOD DETAIL ========== --><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="getAddress()"><!-- --></A><H3>getAddress</H3><PRE><A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getAddress</B>()</PRE><DL><DD>Returns the XMPP address of the service.<P><DD><DL><DT><B>Returns:</B><DD>the XMPP address of the service.</DL></DD></DL><HR><A NAME="getServiceID()"><!-- --></A><H3>getServiceID</H3><PRE><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>getServiceID</B>()</PRE><DL><DD>Returns a String that uniquely identifies this pubsub service. This information is being used when storing node information in the database so it's possible to have nodes with the same ID but under different pubsub services.<P><DD><DL><DT><B>Returns:</B><DD>a String that uniquely identifies this pubsub service.</DL></DD></DL><HR><A NAME="getBarePresences()"><!-- --></A><H3>getBarePresences</H3><PRE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<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>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<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>,<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>getBarePresences</B>()</PRE><DL><DD>Returns a registry of the presence's show value of users that subscribed to a node of the pubsub service and for which the node only delivers notifications for online users or node subscriptions deliver events based on the user presence show value. Offline users will not have an entry in the map. Note: Key-> bare JID and Value-> Map whose key is full JID of connected resource and value is show value of the last received presence.<P><DD><DL><DT><B>Returns:</B><DD>a registry of the presence's show value of users that subscribed to a node of the pubsub service.</DL></DD></DL><HR><A NAME="canCreateNode(org.xmpp.packet.JID)"><!-- --></A><H3>canCreateNode</H3><PRE>boolean <B>canCreateNode</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> creator)</PRE><DL><DD>Returns true if the pubsub service allows the specified user to create nodes.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>creator</CODE> - the JID of the entity trying to create a new node.<DT><B>Returns:</B><DD>true if the pubsub service allows the specified user to create nodes.</DL></DD></DL><HR>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -