asteriskserver.html

关于asterisk的java包

<A NAME="getVersion()"><!-- --></A><H3>
getVersion</H3>
<PRE>
java.lang.String <B>getVersion</B>()
                            throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns the exact version string of this Asterisk server.
 <p/>
 This typically looks like "Asterisk 1.2.9.1-BRIstuffed-0.3.0-PRE-1q built
 by root @ pbx0 on a i686 running Linux on 2006-06-20 20:21:30 UTC".
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the version of this Asterisk server
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the version cannot be retrieved
                                       from Asterisk<DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getVersion(java.lang.String)"><!-- --></A><H3>
getVersion</H3>
<PRE>
int[] <B>getVersion</B>(java.lang.String&nbsp;file)
                 throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns the CVS revision of a given source file of this Asterisk server.
 <p/>
 For example getVersion("app_meetme.c") may return {1, 102} for CVS
 revision "1.102".
 <p/>
 Note that this feature is not available with Asterisk 1.0.x.
 <p/>
 You can use this feature if you need to write applications that behave
 different depending on specific modules being available in a specific
 version or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the file for which to get the version like "app_meetme.c"
<DT><B>Returns:</B><DD>the CVS revision of the file, or <code>null</code> if that file
         is not part of the Asterisk instance you are connected to (maybe
         due to a module that provides it has not been loaded) or if you
         are connected to an Astersion 1.0.x
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the version cannot be retrieved
                                       from Asterisk<DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getGlobalVariable(java.lang.String)"><!-- --></A><H3>
getGlobalVariable</H3>
<PRE>
java.lang.String <B>getGlobalVariable</B>(java.lang.String&nbsp;variable)
                                   throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns the value of the given global variable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>variable</CODE> - the name of the global variable to return.
<DT><B>Returns:</B><DD>the value of the global variable or <code>null</code> if it is
         not set.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the get variable action cannot
                                       be sent to Asterisk.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setGlobalVariable(java.lang.String, java.lang.String)"><!-- --></A><H3>
setGlobalVariable</H3>
<PRE>
void <B>setGlobalVariable</B>(java.lang.String&nbsp;variable,
                       java.lang.String&nbsp;value)
                       throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Sets the value of the given global variable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>variable</CODE> - the name of the global variable to set.<DD><CODE>value</CODE> - the value of the global variable to set.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the set variable action cannot
                                       be sent to Asterisk.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getVoicemailboxes()"><!-- --></A><H3>
getVoicemailboxes</H3>
<PRE>
java.util.Collection&lt;<A HREF="../../../org/asteriskjava/live/Voicemailbox.html" title="class in org.asteriskjava.live">Voicemailbox</A>&gt; <B>getVoicemailboxes</B>()
                                                     throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns a collection of all voicemailboxes configured for this Asterisk
 server with the number of new and old messages they contain.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a collection of all voicemailboxes configured for this Asterisk
         server
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the voicemailboxes can't be
                                       retrieved.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="executeCliCommand(java.lang.String)"><!-- --></A><H3>
executeCliCommand</H3>
<PRE>
java.util.List&lt;java.lang.String&gt; <B>executeCliCommand</B>(java.lang.String&nbsp;command)
                                                   throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Executes a command line interface (CLI) command.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>command</CODE> - the command to execute, for example "sip show peers".
<DT><B>Returns:</B><DD>a List containing strings representing the lines returned by the CLI command.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the command can't be executed.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/asteriskjava/manager/action/CommandAction.html" title="class in org.asteriskjava.manager.action"><CODE>CommandAction</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addAsteriskServerListener(org.asteriskjava.live.AsteriskServerListener)"><!-- --></A><H3>
addAsteriskServerListener</H3>
<PRE>
void <B>addAsteriskServerListener</B>(<A HREF="../../../org/asteriskjava/live/AsteriskServerListener.html" title="interface in org.asteriskjava.live">AsteriskServerListener</A>&nbsp;listener)
                               throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Adds a listener to this AsteriskServer.
 <p/>
 If this server is not yet connected it will be implicitly connected.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to add.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the server is not yet connected and the connection or initialization fails.</DL>
</DD>
</DL>
<HR>

<A NAME="removeAsteriskServerListener(org.asteriskjava.live.AsteriskServerListener)"><!-- --></A><H3>
removeAsteriskServerListener</H3>
<PRE>
void <B>removeAsteriskServerListener</B>(<A HREF="../../../org/asteriskjava/live/AsteriskServerListener.html" title="interface in org.asteriskjava.live">AsteriskServerListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Removes a listener from this Asterisk server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to remove.</DL>
</DD>
</DL>
<HR>

<A NAME="shutdown()"><!-- --></A><H3>
shutdown</H3>
<PRE>
void <B>shutdown</B>()</PRE>
<DL>
<DD>Closes the connection to this server.
<P>
<DD><DL>
</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="class-use/AsteriskServer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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>
Asterisk-Java</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/asteriskjava/live/AsteriskQueueListener.html" title="interface in org.asteriskjava.live"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/asteriskjava/live/AsteriskServerListener.html" title="interface in org.asteriskjava.live"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/asteriskjava/live/AsteriskServer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="AsteriskServer.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>
Copyright &copy; 2004-2007 Stefan Reuter. All Rights Reserved.
</BODY>
</HTML>