📄 agentsession.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.5.0_07) on Thu Jun 21 14:48:24 PDT 2007 --><TITLE>AgentSession (Smack 3.0.4 Documentation)</TITLE><META NAME="keywords" CONTENT="org.jivesoftware.smackx.workgroup.agent.AgentSession class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="AgentSession (Smack 3.0.4 Documentation)";}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" 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_top_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> </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><b>Smack</b></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentRosterListener.html" title="interface in org.jivesoftware.smackx.workgroup.agent"><B>PREV CLASS</B></A> <A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/InvitationRequest.html" title="class in org.jivesoftware.smackx.workgroup.agent"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/jivesoftware/smackx/workgroup/agent/AgentSession.html" target="_top"><B>FRAMES</B></A> <A HREF="AgentSession.html" target="_top"><B>NO FRAMES</B></A> <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: 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><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.jivesoftware.smackx.workgroup.agent</FONT><BR>Class AgentSession</H2><PRE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.jivesoftware.smackx.workgroup.agent.AgentSession</B></PRE><HR><DL><DT><PRE>public class <B>AgentSession</B><DT>extends <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL></PRE><P>This class embodies the agent's active presence within a given workgroup. The application should have N instances of this class, where N is the number of workgroups to which the owning agent of the application belongs. This class provides all functionality that a session within a given workgroup is expected to have from an agent's perspective -- setting the status, tracking the status of queues to which the agent belongs within the workgroup, and dequeuing customers.<P><P><DL><DT><B>Author:</B></DT> <DD>Matt Tucker, Derek DeMoro</DD></DL><HR><P><!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentSession.html#AgentSession(java.lang.String, org.jivesoftware.smack.XMPPConnection)">AgentSession</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> workgroupJID, <A HREF="../../../../../org/jivesoftware/smack/XMPPConnection.html" title="class in org.jivesoftware.smack">XMPPConnection</A> connection)</CODE><BR> Constructs a new agent session instance.</TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></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/smackx/workgroup/agent/AgentSession.html#addInvitationListener(org.jivesoftware.smackx.workgroup.WorkgroupInvitationListener)">addInvitationListener</A></B>(<A HREF="../../../../../org/jivesoftware/smackx/workgroup/WorkgroupInvitationListener.html" title="interface in org.jivesoftware.smackx.workgroup">WorkgroupInvitationListener</A> invitationListener)</CODE><BR> Adds an invitation listener.</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/smackx/workgroup/agent/AgentSession.html#addOfferListener(org.jivesoftware.smackx.workgroup.agent.OfferListener)">addOfferListener</A></B>(<A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/OfferListener.html" title="interface in org.jivesoftware.smackx.workgroup.agent">OfferListener</A> offerListener)</CODE><BR> Adds an offer listener.</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/smackx/workgroup/agent/AgentSession.html#addQueueUsersListener(org.jivesoftware.smackx.workgroup.agent.QueueUsersListener)">addQueueUsersListener</A></B>(<A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/QueueUsersListener.html" title="interface in org.jivesoftware.smackx.workgroup.agent">QueueUsersListener</A> listener)</CODE><BR> </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/smackx/workgroup/agent/AgentSession.html#close()">close</A></B>()</CODE><BR> Close the agent session.</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/smackx/workgroup/agent/AgentSession.html#dequeueUser(java.lang.String)">dequeueUser</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> userID)</CODE><BR> Removes a user from the workgroup queue.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/Agent.html" title="class in org.jivesoftware.smackx.workgroup.agent">Agent</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentSession.html#getAgent()">getAgent</A></B>()</CODE><BR> Returns the Agent associated to this session.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../org/jivesoftware/smackx/workgroup/ext/history/AgentChatHistory.html" title="class in org.jivesoftware.smackx.workgroup.ext.history">AgentChatHistory</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentSession.html#getAgentHistory(java.lang.String, int, java.util.Date)">getAgentHistory</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> jid, int maxSessions, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A> startDate)</CODE><BR> Retrieves the AgentChatHistory associated with a particular agent jid.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentRoster.html" title="class in org.jivesoftware.smackx.workgroup.agent">AgentRoster</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentSession.html#getAgentRoster()">getAgentRoster</A></B>()</CODE><BR> Returns the agent roster for the workgroup, which contains</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.3/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentSession.html#getChatMetadata(java.lang.String)">getChatMetadata</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> sessionID)</CODE><BR> Query for metadata associated with a session id.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/GenericSettings.html" title="class in org.jivesoftware.smackx.workgroup.settings">GenericSettings</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/jivesoftware/smackx/workgroup/agent/AgentSession.html#getGenericSettings(org.jivesoftware.smack.XMPPConnection, java.lang.String)">getGenericSettings</A></B>(<A HREF="../../../../../org/jivesoftware/smack/XMPPConnection.html" title="class in org.jivesoftware.smack">XMPPConnection</A> con, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> query)</CODE><BR> Returns the generic metadata of the workgroup the agent belongs to.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../../org/jivesoftware/smackx/workgroup/ext/macros/MacroGroup.html" title="class in org.jivesoftware.smackx.workgroup.ext.macros">MacroGroup</A></CODE></FONT></TD>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -