📄 multiuserchatservice.html
字号:
Returns the total chat time of all rooms combined.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html#getUserIdleTime()">getUserIdleTime</A></B>()</CODE><BR> Returns the number of milliseconds a user must be idle before he/she gets kicked from all the rooms.</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/muc/MultiUserChatService.html#getUsersAllowedToCreate()">getUsersAllowedToCreate</A></B>()</CODE><BR> Returns the collection of JIDs that are allowed to create MUC rooms.</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/muc/MultiUserChatService.html#hasChatRoom(java.lang.String)">hasChatRoom</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> roomName)</CODE><BR> Returns true if the server includes a chatroom with the requested name.</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/muc/MultiUserChatService.html#isHidden()">isHidden</A></B>()</CODE><BR> Returns true if the MUC service is a hidden, externally managed, 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/muc/MultiUserChatService.html#isRoomCreationRestricted()">isRoomCreationRestricted</A></B>()</CODE><BR> Returns false if anyone can create rooms or true if only the returned JIDs in <code>getUsersAllowedToCreate</code> are allowed to create rooms.</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/muc/MultiUserChatService.html#isServiceEnabled()">isServiceEnabled</A></B>()</CODE><BR> Returns true if the MUC service is available.</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/muc/MultiUserChatService.html#logConversation(org.jivesoftware.openfire.muc.MUCRoom, org.xmpp.packet.Message, org.xmpp.packet.JID)">logConversation</A></B>(<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A> room, <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> sender)</CODE><BR> Logs that a given message was sent to a room as part of a conversation.</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/muc/MultiUserChatService.html#messageBroadcastedTo(int)">messageBroadcastedTo</A></B>(int numOccupants)</CODE><BR> Notification message indicating the server that an incoming message was broadcasted to a given number of occupants.</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/muc/MultiUserChatService.html#removeChatRoom(java.lang.String)">removeChatRoom</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> roomName)</CODE><BR> Removes the room associated with the given name.</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/muc/MultiUserChatService.html#removeSysadmin(java.lang.String)">removeSysadmin</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> userJID)</CODE><BR> Removes a system administrator of the MUC 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/muc/MultiUserChatService.html#removeUserAllowedToCreate(java.lang.String)">removeUserAllowedToCreate</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> userJID)</CODE><BR> Removes a user from list of JIDs that are allowed to create MUC rooms.</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/muc/MultiUserChatService.html#setKickIdleUsersTimeout(int)">setKickIdleUsersTimeout</A></B>(int timeout)</CODE><BR> Sets the time to elapse between clearing of idle chat users.</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/muc/MultiUserChatService.html#setLogConversationBatchSize(int)">setLogConversationBatchSize</A></B>(int size)</CODE><BR> Sets the number of messages to save to the database on each run of the logging process.</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/muc/MultiUserChatService.html#setLogConversationsTimeout(int)">setLogConversationsTimeout</A></B>(int timeout)</CODE><BR> Sets the time to elapse between logging the room conversations.</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/muc/MultiUserChatService.html#setRoomCreationRestricted(boolean)">setRoomCreationRestricted</A></B>(boolean roomCreationRestricted)</CODE><BR> Sets if anyone can create rooms or if only the returned JIDs in <code>getUsersAllowedToCreate</code> are allowed to create rooms.</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/muc/MultiUserChatService.html#setUserIdleTime(int)">setUserIdleTime</A></B>(int idle)</CODE><BR> Sets the number of milliseconds a user must be idle before he/she gets kicked from all the rooms.</TD></TR></TABLE> <A NAME="methods_inherited_from_class_org.xmpp.component.Component"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Methods inherited from interface org.xmpp.component.<A HREF="../../../../org/xmpp/component/Component.html" title="interface in org.xmpp.component">Component</A></B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><A HREF="../../../../org/xmpp/component/Component.html#getDescription()">getDescription</A>, <A HREF="../../../../org/xmpp/component/Component.html#getName()">getName</A>, <A HREF="../../../../org/xmpp/component/Component.html#initialize(org.xmpp.packet.JID, org.xmpp.component.ComponentManager)">initialize</A>, <A HREF="../../../../org/xmpp/component/Component.html#processPacket(org.xmpp.packet.Packet)">processPacket</A>, <A HREF="../../../../org/xmpp/component/Component.html#shutdown()">shutdown</A>, <A HREF="../../../../org/xmpp/component/Component.html#start()">start</A></CODE></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="getServiceDomain()"><!-- --></A><H3>getServiceDomain</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>getServiceDomain</B>()</PRE><DL><DD>Returns the fully-qualifed domain name of this chat service. The domain is composed by the service name and the name of the XMPP server where the service is running.<P><DD><DL></DL></DD><DD><DL><DT><B>Returns:</B><DD>the chat server domain (service name + host name).</DL></DD></DL><HR><A NAME="getServiceName()"><!-- --></A><H3>getServiceName</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>getServiceName</B>()</PRE><DL><DD>Returns the subdomain of the chat service.<P><DD><DL></DL></DD><DD><DL><DT><B>Returns:</B><DD>the subdomain of the chat service.</DL></DD></DL><HR><A NAME="getSysadmins()"><!-- --></A><H3>getSysadmins</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><<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>getSysadmins</B>()</PRE><DL><DD>Returns the collection of JIDs that are system administrators of the MUC service. A sysadmin has the same permissions as a room owner.<P><DD><DL></DL></DD><DD><DL><DT><B>Returns:</B><DD>a list of bare JIDs.</DL></DD></DL><HR><A NAME="addSysadmin(java.lang.String)"><!-- --></A><H3>addSysadmin</H3><PRE>void <B>addSysadmin</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> userJID)</PRE><DL><DD>Adds a new system administrator of the MUC service. A sysadmin has the same permissions as a room owner.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>userJID</CODE> - the bare JID of the new user to add as a system administrator.</DL></DD></DL><HR><A NAME="removeSysadmin(java.lang.String)"><!-- --></A><H3>removeSysadmin</H3><PRE>void <B>removeSysadmin</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> userJID)</PRE><DL><DD>Removes a system administrator of the MUC service.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>userJID</CODE> - the bare JID of the user to remove from the list.</DL></DD></DL><HR><A NAME="isRoomCreationRestricted()"><!-- --></A><H3>isRoomCreationRestricted</H3><PRE>boolean <B>isRoomCreationRestricted</B>()</PRE><DL><DD>Returns false if anyone can create rooms or true if only the returned JIDs in <code>getUsersAllowedToCreate</code> are allowed to create rooms.<P><DD><DL></DL></DD><DD><DL><DT><B>Returns:</B><DD>true if only some JIDs are allowed to create rooms.</DL></DD></DL><HR><A NAME="setRoomCreationRestricted(boolean)"><!-- --></A><H3>setRoomCreationRestricted</H3><PRE>void <B>setRoomCreationRestricted</B>(boolean roomCreationRestricted)</PRE><DL><DD>Sets if anyone can create rooms or if only the returned JIDs in <code>getUsersAllowedToCreate</code> are allowed to create rooms.<P><DD><DL></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>roomCreationRestricted</CODE> - whether anyone can create rooms or not.</DL></DD></DL><HR><A NAME="getUsersAllowedToCreate()"><!-- --></A><H3>getUsersAllowedToCreate</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><<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>getUsersAllowedToCreate</B>()</PRE><DL><DD>Returns the collection of JIDs that are allowed to create MUC rooms. An empty list means that anyone can create a room.<P><DD><DL></DL></DD><DD><DL><DT><B>Returns:</B><DD>a list of bare JIDs.</DL></DD></DL><HR><A NAME="addUserAllowedToCreate(java.lang.String)"><!-- --></A><H3>addUserAllowedToCreate</H3>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -