📄 chatroom.html
字号:
launched. Duplicated listeners (identified by listenerID) are not allowed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - <DT><B>Since:</B></DT> <DD>2.6</DD></DL>
</DD>
</DL>
<HR>
<A NAME="runTimer(jChatBox.Chat.Event.ChatroomListener)"><!-- --></A><H3>
runTimer</H3>
<PRE>
protected void <B>runTimer</B>(<A HREF="../../jChatBox/Chat/Event/ChatroomListener.html">ChatroomListener</A> listener)</PRE>
<DL>
<DD>Run ChatroomTimer in a Thread.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - <DT><B>Since:</B></DT> <DD>2.6</DD></DL>
</DD>
</DL>
<HR>
<A NAME="removeListener(jChatBox.Chat.Event.ChatroomListener)"><!-- --></A><H3>
removeListener</H3>
<PRE>
public void <B>removeListener</B>(<A HREF="../../jChatBox/Chat/Event/ChatroomListener.html">ChatroomListener</A> listener)</PRE>
<DL>
<DD>Remove listener.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - <DT><B>Since:</B></DT> <DD>2.6</DD></DL>
</DD>
</DL>
<HR>
<A NAME="notifyListeners(jChatBox.Chat.Event.ChatroomEvent)"><!-- --></A><H3>
notifyListeners</H3>
<PRE>
protected void <B>notifyListeners</B>(<A HREF="../../jChatBox/Chat/Event/ChatroomEvent.html">ChatroomEvent</A> event)</PRE>
<DL>
<DD>Notify chatroom's listeners.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - <DT><B>Since:</B></DT> <DD>2.6</DD></DL>
</DD>
</DL>
<HR>
<A NAME="getListeners()"><!-- --></A><H3>
getListeners</H3>
<PRE>
public java.util.Vector <B>getListeners</B>()</PRE>
<DL>
<DD>Return chatroom's listeners.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>listeners.<DT><B>Since:</B></DT> <DD>2.6</DD></DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>Close the Chatroom.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDate()"><!-- --></A><H3>
getDate</H3>
<PRE>
public java.util.Date <B>getDate</B>()</PRE>
<DL>
<DD>Returns opening date.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="addUser(jChatBox.Chat.ChatroomUser)"><!-- --></A><H3>
addUser</H3>
<PRE>
public void <B>addUser</B>(<A HREF="../../jChatBox/Chat/ChatroomUser.html">ChatroomUser</A> newUser) throws <A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></PRE>
<DL>
<DD>Adds user to Chatroom. <br> Check Chatroom's state.<br> Check blacklist entries.<br> Check quota. (No apply if SYSTEM user)<br> Check duplicate nickname.<br> Allow SystemLogin only for SYSTEM or MODERATOR users (no case sensitive).<br>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DD><CODE><A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getUser(java.lang.String)"><!-- --></A><H3>
getUser</H3>
<PRE>
public <A HREF="../../jChatBox/Chat/ChatroomUser.html">ChatroomUser</A> <B>getUser</B>(java.lang.String name)</PRE>
<DL>
<DD>Returns an User.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTotalUsers()"><!-- --></A><H3>
getTotalUsers</H3>
<PRE>
public int <B>getTotalUsers</B>()</PRE>
<DL>
<DD>Counts Users.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getParams()"><!-- --></A><H3>
getParams</H3>
<PRE>
public <A HREF="../../jChatBox/Chat/ChatroomParams.html">ChatroomParams</A> <B>getParams</B>()</PRE>
<DL>
<DD>Returns Chatroom's parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="updateParams(jChatBox.Chat.ChatroomParams)"><!-- --></A><H3>
updateParams</H3>
<PRE>
public void <B>updateParams</B>(<A HREF="../../jChatBox/Chat/ChatroomParams.html">ChatroomParams</A> params)</PRE>
<DL>
<DD>Updates Chatroom's parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="addToBlacklist(jChatBox.Chat.ChatroomUser, java.lang.String)"><!-- --></A><H3>
addToBlacklist</H3>
<PRE>
public void <B>addToBlacklist</B>(<A HREF="../../jChatBox/Chat/ChatroomUser.html">ChatroomUser</A> user, java.lang.String reason) throws <A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></PRE>
<DL>
<DD>Add user to blacklist.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DD><CODE><A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="removeFromBlacklist(java.lang.String)"><!-- --></A><H3>
removeFromBlacklist</H3>
<PRE>
public void <B>removeFromBlacklist</B>(java.lang.String ip)</PRE>
<DL>
<DD>Remove IP from blacklist.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="resetBlacklist()"><!-- --></A><H3>
resetBlacklist</H3>
<PRE>
public void <B>resetBlacklist</B>()</PRE>
<DL>
<DD>Reset Blacklist.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getBlacklist()"><!-- --></A><H3>
getBlacklist</H3>
<PRE>
public <A HREF="../../jChatBox/Chat/Blacklist.html">Blacklist</A> <B>getBlacklist</B>()</PRE>
<DL>
<DD>Returns Blacklist.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="removeUser(java.lang.String)"><!-- --></A><H3>
removeUser</H3>
<PRE>
public void <B>removeUser</B>(java.lang.String name) throws <A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></PRE>
<DL>
<DD>Removes an User.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DD><CODE><A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="addMsg(jChatBox.Chat.Msg)"><!-- --></A><H3>
addMsg</H3>
<PRE>
public void <B>addMsg</B>(<A HREF="../../jChatBox/Chat/Msg.html">Msg</A> msg) throws <A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></PRE>
<DL>
<DD>Adds message to Chat. null content message is discarded.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DD><CODE><A HREF="../../jChatBox/Chat/ChatException.html">ChatException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getChat()"><!-- --></A><H3>
getChat</H3>
<PRE>
public java.util.Vector <B>getChat</B>()</PRE>
<DL>
<DD>Returns the whole Chat.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getChat(java.lang.String)"><!-- --></A><H3>
getChat</H3>
<PRE>
public java.util.Vector <B>getChat</B>(java.lang.String username)</PRE>
<DL>
<DD>Returns the Chat content for an user only. <br> We filter on "To" field. (To==username OR To==ALL OR To=BROADCAST OR myPrivateMsg)<br> myPrivateMsg = (Type==PRIVATE AND From==username)
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getUsers()"><!-- --></A><H3>
getUsers</H3>
<PRE>
public java.util.Hashtable <B>getUsers</B>()</PRE>
<DL>
<DD>Returns Users.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="clear()"><!-- --></A><H3>
clear</H3>
<PRE>
public void <B>clear</B>()</PRE>
<DL>
<DD>Clear chatroom content.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="performLogout(jChatBox.Chat.ChatroomUser)"><!-- --></A><H3>
performLogout</H3>
<PRE>
public void <B>performLogout</B>(<A HREF="../../jChatBox/Chat/ChatroomUser.html">ChatroomUser</A> user)</PRE>
<DL>
<DD>Remove user from chatroom. His HttpSession timed out or invalidated.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jChatBox/Chat/LogListener.html#performLogout(jChatBox.Chat.ChatroomUser)">performLogout</A></CODE> in interface <CODE><A HREF="../../jChatBox/Chat/LogListener.html">LogListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="performLogin(jChatBox.Chat.ChatroomUser)"><!-- --></A><H3>
performLogin</H3>
<PRE>
public void <B>performLogin</B>(<A HREF="../../jChatBox/Chat/ChatroomUser.html">ChatroomUser</A> user)</PRE>
<DL>
<DD>LogListener dummy implementation.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jChatBox/Chat/LogListener.html#performLogin(jChatBox.Chat.ChatroomUser)">performLogin</A></CODE> in interface <CODE><A HREF="../../jChatBox/Chat/LogListener.html">LogListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../jChatBox/Chat/Blacklist.html"><B>PREV CLASS</B></A>
<A HREF="../../jChatBox/Chat/ChatroomManager.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Chatroom.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT><A HREF="../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A></NOSCRIPT></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -