multiuserchatservice.html

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

<HR>

<A NAME="removeChatRoom(java.lang.String)"><!-- --></A><H3>
removeChatRoom</H3>
<PRE>
void <B>removeChatRoom</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;roomName)</PRE>
<DL>
<DD>Removes the room associated with the given name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roomName</CODE> - The room to remove.</DL>
</DD>
</DL>
<HR>

<A NAME="getMUCRoles(org.xmpp.packet.JID)"><!-- --></A><H3>
getMUCRoles</H3>
<PRE>
<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/jivesoftware/openfire/muc/MUCRole.html" title="interface in org.jivesoftware.openfire.muc">MUCRole</A>&gt; <B>getMUCRoles</B>(<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;user)</PRE>
<DL>
<DD>Returns the list of <A HREF="../../../../org/jivesoftware/openfire/muc/MUCRole.html" title="interface in org.jivesoftware.openfire.muc"><CODE>MUCRole</CODE></A> in all rooms for the specified
 user's session. When running in a cluster the list will include
 <A HREF="../../../../org/jivesoftware/openfire/muc/spi/LocalMUCRole.html" title="class in org.jivesoftware.openfire.muc.spi"><CODE>LocalMUCRole</CODE></A> and <A HREF="../../../../org/jivesoftware/openfire/muc/spi/RemoteMUCRole.html" title="class in org.jivesoftware.openfire.muc.spi"><CODE>RemoteMUCRole</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - the full JID that identifies the session of the user.
<DT><B>Returns:</B><DD>the list of MUCRoles in all rooms for the specified user's session.</DL>
</DD>
</DL>
<HR>

<A NAME="getTotalChatTime()"><!-- --></A><H3>
getTotalChatTime</H3>
<PRE>
long <B>getTotalChatTime</B>()</PRE>
<DL>
<DD>Returns the total chat time of all rooms combined.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>total chat time in milliseconds.</DL>
</DD>
</DL>
<HR>

<A NAME="getNumberChatRooms()"><!-- --></A><H3>
getNumberChatRooms</H3>
<PRE>
int <B>getNumberChatRooms</B>()</PRE>
<DL>
<DD>Retuns the number of existing rooms in the server (i.e. persistent or not,
 in memory or not).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the number of existing rooms in the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getNumberConnectedUsers(boolean)"><!-- --></A><H3>
getNumberConnectedUsers</H3>
<PRE>
int <B>getNumberConnectedUsers</B>(boolean&nbsp;onlyLocal)</PRE>
<DL>
<DD>Retuns the total number of occupants in all rooms in the server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>onlyLocal</CODE> - true if only users connected to this JVM will be considered. Otherwise count cluster wise.
<DT><B>Returns:</B><DD>the number of existing rooms in the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getNumberRoomOccupants()"><!-- --></A><H3>
getNumberRoomOccupants</H3>
<PRE>
int <B>getNumberRoomOccupants</B>()</PRE>
<DL>
<DD>Retuns the total number of users that have joined in all rooms in the server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the number of existing rooms in the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getIncomingMessageCount(boolean)"><!-- --></A><H3>
getIncomingMessageCount</H3>
<PRE>
long <B>getIncomingMessageCount</B>(boolean&nbsp;resetAfter)</PRE>
<DL>
<DD>Returns the total number of incoming messages since last reset.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resetAfter</CODE> - True if you want the counter to be reset after results returned.
<DT><B>Returns:</B><DD>the number of incoming messages through the service.</DL>
</DD>
</DL>
<HR>

<A NAME="getOutgoingMessageCount(boolean)"><!-- --></A><H3>
getOutgoingMessageCount</H3>
<PRE>
long <B>getOutgoingMessageCount</B>(boolean&nbsp;resetAfter)</PRE>
<DL>
<DD>Returns the total number of outgoing messages since last reset.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resetAfter</CODE> - True if you want the counter to be reset after results returned.
<DT><B>Returns:</B><DD>the number of outgoing messages through the service.</DL>
</DD>
</DL>
<HR>

<A NAME="logConversation(org.jivesoftware.openfire.muc.MUCRoom, org.xmpp.packet.Message, org.xmpp.packet.JID)"><!-- --></A><H3>
logConversation</H3>
<PRE>
void <B>logConversation</B>(<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A>&nbsp;room,
                     <A HREF="../../../../org/xmpp/packet/Message.html" title="class in org.xmpp.packet">Message</A>&nbsp;message,
                     <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;sender)</PRE>
<DL>
<DD>Logs that a given message was sent to a room as part of a conversation. Every message sent
 to the room that is allowed to be broadcasted and that was sent either from the room itself 
 or from an occupant will be logged.<p>
 
 Note: For performane reasons, the logged message won't be immediately saved. Instead we keep
 the logged messages in memory until the logging process saves them to the database. It's 
 possible to configure the logging process to run every X milliseconds and also the number 
 of messages to log on each execution.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - the room that received the message.<DD><CODE>message</CODE> - the message to log as part of the conversation in the room.<DD><CODE>sender</CODE> - the real XMPPAddress of the sender (e.g. [e-mail]).<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/muc/spi/MultiUserChatServiceImpl.html#initialize(org.jivesoftware.openfire.XMPPServer)"><CODE>MultiUserChatServiceImpl.initialize(org.jivesoftware.openfire.XMPPServer)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="messageBroadcastedTo(int)"><!-- --></A><H3>
messageBroadcastedTo</H3>
<PRE>
void <B>messageBroadcastedTo</B>(int&nbsp;numOccupants)</PRE>
<DL>
<DD>Notification message indicating the server that an incoming message was broadcasted
 to a given number of occupants.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>numOccupants</CODE> - number of occupants that received the message.</DL>
</DD>
</DL>
<HR>

<A NAME="enableService(boolean, boolean)"><!-- --></A><H3>
enableService</H3>
<PRE>
void <B>enableService</B>(boolean&nbsp;enabled,
                   boolean&nbsp;persistent)</PRE>
<DL>
<DD>Enables or disables the MUC service. When disabled the MUC service will disappear from
 the disco#items list. Moreover, service discovery features will be disabled.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if the service is enabled.<DD><CODE>persistent</CODE> - true if the new setting will persist across restarts.</DL>
</DD>
</DL>
<HR>

<A NAME="isServiceEnabled()"><!-- --></A><H3>
isServiceEnabled</H3>
<PRE>
boolean <B>isServiceEnabled</B>()</PRE>
<DL>
<DD>Returns true if the MUC service is available. Use <A HREF="../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#enableService(boolean, boolean)"><CODE>enableService(boolean, boolean)</CODE></A> to
 enable or disable the service.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the MUC service is available.</DL>
</DD>
</DL>
<HR>

<A NAME="isHidden()"><!-- --></A><H3>
isHidden</H3>
<PRE>
boolean <B>isHidden</B>()</PRE>
<DL>
<DD>Returns true if the MUC service is a hidden, externally managed, service.  This is typically
 set to true when the implementation is not the default one, and is not to be managed by
 the standard Openfire interface.  If this is set to true, the service will not show up in
 the service list in the admin console.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the MUC service is hidden and externally managed.</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/muc/MultiUserChatManager.html" title="class in org.jivesoftware.openfire.muc"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/muc/NotAcceptableException.html" title="class in org.jivesoftware.openfire.muc"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/muc/MultiUserChatService.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="MultiUserChatService.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;NESTED&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>