workgroup.html

开源项目smack的API文件

<HR>

<A NAME="removeQueueListener(org.jivesoftware.smackx.workgroup.WorkgroupInvitationListener)"><!-- --></A><H3>
removeQueueListener</H3>
<PRE>
public void <B>removeQueueListener</B>(<A HREF="../../../../../org/jivesoftware/smackx/workgroup/WorkgroupInvitationListener.html" title="interface in org.jivesoftware.smackx.workgroup">WorkgroupInvitationListener</A>&nbsp;invitationListener)</PRE>
<DL>
<DD>Removes an invitation listener.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>invitationListener</CODE> - the invitation listener.</DL>
</DD>
</DL>
<HR>

<A NAME="getChatSetting(java.lang.String)"><!-- --></A><H3>
getChatSetting</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/ChatSetting.html" title="class in org.jivesoftware.smackx.workgroup.settings">ChatSetting</A> <B>getChatSetting</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>&nbsp;key)
                           throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Returns a single chat setting based on it's identified key.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key to find.
<DT><B>Returns:</B><DD>the ChatSetting if found, otherwise false.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while getting information from the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getChatSettings(int)"><!-- --></A><H3>
getChatSettings</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/ChatSettings.html" title="class in org.jivesoftware.smackx.workgroup.settings">ChatSettings</A> <B>getChatSettings</B>(int&nbsp;type)
                             throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Returns ChatSettings based on type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type of ChatSettings to return.
<DT><B>Returns:</B><DD>the ChatSettings of given type, otherwise null.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while getting information from the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getChatSettings()"><!-- --></A><H3>
getChatSettings</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/ChatSettings.html" title="class in org.jivesoftware.smackx.workgroup.settings">ChatSettings</A> <B>getChatSettings</B>()
                             throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Returns all ChatSettings.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>all ChatSettings of a given workgroup.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while getting information from the server.</DL>
</DD>
</DL>
<HR>

<A NAME="isEmailAvailable()"><!-- --></A><H3>
isEmailAvailable</H3>
<PRE>
public boolean <B>isEmailAvailable</B>()</PRE>
<DL>
<DD>The workgroup service may be configured to send email. This queries the Workgroup Service
 to see if the email service has been configured and is available.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the email service is available, otherwise return false.</DL>
</DD>
</DL>
<HR>

<A NAME="getOfflineSettings()"><!-- --></A><H3>
getOfflineSettings</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/OfflineSettings.html" title="class in org.jivesoftware.smackx.workgroup.settings">OfflineSettings</A> <B>getOfflineSettings</B>()
                                   throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Asks the workgroup for it's Offline Settings.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>offlineSettings the offline settings for this workgroup.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while getting information from the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getSoundSettings()"><!-- --></A><H3>
getSoundSettings</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/SoundSettings.html" title="class in org.jivesoftware.smackx.workgroup.settings">SoundSettings</A> <B>getSoundSettings</B>()
                               throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Asks the workgroup for it's Sound Settings.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>soundSettings the sound settings for the specified workgroup.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while getting information from the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getWorkgroupProperties()"><!-- --></A><H3>
getWorkgroupProperties</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/WorkgroupProperties.html" title="class in org.jivesoftware.smackx.workgroup.settings">WorkgroupProperties</A> <B>getWorkgroupProperties</B>()
                                           throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Asks the workgroup for it's Properties
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the WorkgroupProperties for the specified workgroup.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while getting information from the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getWorkgroupProperties(java.lang.String)"><!-- --></A><H3>
getWorkgroupProperties</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/workgroup/settings/WorkgroupProperties.html" title="class in org.jivesoftware.smackx.workgroup.settings">WorkgroupProperties</A> <B>getWorkgroupProperties</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>&nbsp;jid)
                                           throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Asks the workgroup for it's Properties
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the jid of the user who's information you would like the workgroup to retreive.
<DT><B>Returns:</B><DD>the WorkgroupProperties for the specified workgroup.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while getting information from the server.</DL>
</DD>
</DL>
<HR>

<A NAME="getWorkgroupForm()"><!-- --></A><H3>
getWorkgroupForm</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/smackx/Form.html" title="class in org.jivesoftware.smackx">Form</A> <B>getWorkgroupForm</B>()
                      throws <A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></PRE>
<DL>
<DD>Returns the Form to use for all clients of a workgroup. It is unlikely that the server
 will change the form (without a restart) so it is safe to keep the returned form
 for future submissions.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the Form to use for searching transcripts.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/smack/XMPPException.html" title="class in org.jivesoftware.smack">XMPPException</A></CODE> - if an error occurs while sending the request to the server.</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>Smack</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/jivesoftware/smackx/workgroup/user/QueueListener.html" title="interface in org.jivesoftware.smackx.workgroup.user"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?org/jivesoftware/smackx/workgroup/user/Workgroup.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Workgroup.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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-2007 Jive Software. </i>
</BODY>
</HTML>