agioperations.html

关于asterisk的java包

 by starting to enter digits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the name of the file to play<DD><CODE>timeout</CODE> - the timeout in milliseconds to wait for user input.
            <p>
            0 means standard timeout value, -1 means "ludicrous time"
            (essentially never times out).
<DT><B>Returns:</B><DD>a String containing the DTMF the user entered
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getData(java.lang.String, int, int)"><!-- --></A><H3>
getData</H3>
<PRE>
public java.lang.String <B>getData</B>(java.lang.String&nbsp;file,
                                int&nbsp;timeout,
                                int&nbsp;maxDigits)
                         throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Plays the given file and waits for the user to enter DTMF digits until he
 presses '#' or the timeout occurs or the maximum number of digits has
 been entered. The user may interrupt the streaming by starting to enter
 digits.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the name of the file to play<DD><CODE>timeout</CODE> - the timeout in milliseconds to wait for user input.
            <p>
            0 means standard timeout value, -1 means "ludicrous time"
            (essentially never times out).<DD><CODE>maxDigits</CODE> - the maximum number of digits the user is allowed to
            enter
<DT><B>Returns:</B><DD>a String containing the DTMF the user entered
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getOption(java.lang.String, java.lang.String)"><!-- --></A><H3>
getOption</H3>
<PRE>
public char <B>getOption</B>(java.lang.String&nbsp;file,
                      java.lang.String&nbsp;escapeDigits)
               throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Plays the given file, and waits for the user to press one of the given
 digits. If none of the esacpe digits is pressed while streaming the file
 it waits for the default timeout of 5 seconds still waiting for the user
 to press a digit.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the name of the file to stream, must not include extension.<DD><CODE>escapeDigits</CODE> - contains the digits that the user is expected to
            press.
<DT><B>Returns:</B><DD>the DTMF digit pressed or 0x0 if none was pressed.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getOption(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
getOption</H3>
<PRE>
public char <B>getOption</B>(java.lang.String&nbsp;file,
                      java.lang.String&nbsp;escapeDigits,
                      int&nbsp;timeout)
               throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Plays the given file, and waits for the user to press one of the given
 digits. If none of the esacpe digits is pressed while streaming the file
 it waits for the specified timeout still waiting for the user to press a
 digit.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the name of the file to stream, must not include extension.<DD><CODE>escapeDigits</CODE> - contains the digits that the user is expected to
            press.<DD><CODE>timeout</CODE> - the timeout in seconds to wait if none of the defined
            esacpe digits was presses while streaming.
<DT><B>Returns:</B><DD>the DTMF digit pressed or 0x0 if none was pressed.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="exec(java.lang.String)"><!-- --></A><H3>
exec</H3>
<PRE>
public int <B>exec</B>(java.lang.String&nbsp;application)
         throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Executes the given command.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>application</CODE> - the name of the application to execute, for example
            "Dial".
<DT><B>Returns:</B><DD>the return code of the application of -2 if the application was
         not found.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="exec(java.lang.String, java.lang.String)"><!-- --></A><H3>
exec</H3>
<PRE>
public int <B>exec</B>(java.lang.String&nbsp;application,
                java.lang.String&nbsp;options)
         throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Executes the given command.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>application</CODE> - the name of the application to execute, for example
            "Dial".<DD><CODE>options</CODE> - the parameters to pass to the application, for example
            "SIP/123". Multiple options are separated by the pipe
            character ('|').
<DT><B>Returns:</B><DD>the return code of the application of -2 if the application was
         not found.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setContext(java.lang.String)"><!-- --></A><H3>
setContext</H3>
<PRE>
public void <B>setContext</B>(java.lang.String&nbsp;context)
                throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Sets the context for continuation upon exiting the application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the context for continuation upon exiting the application.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setExtension(java.lang.String)"><!-- --></A><H3>
setExtension</H3>
<PRE>
public void <B>setExtension</B>(java.lang.String&nbsp;extension)
                  throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Sets the extension for continuation upon exiting the application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>extension</CODE> - the extension for continuation upon exiting the
            application.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setPriority(java.lang.String)"><!-- --></A><H3>
setPriority</H3>
<PRE>
public void <B>setPriority</B>(java.lang.String&nbsp;priority)
                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Sets the priority or label for continuation upon exiting the application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>priority</CODE> - the priority or label for continuation upon exiting the
            application.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="streamFile(java.lang.String)"><!-- --></A><H3>
streamFile</H3>
<PRE>
public void <B>streamFile</B>(java.lang.String&nbsp;file)
                throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Plays the given file.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - name of the file to play.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="streamFile(java.lang.String, java.lang.String)"><!-- --></A><H3>
streamFile</H3>
<PRE>
public char <B>streamFile</B>(java.lang.String&nbsp;file,
                       java.lang.String&nbsp;escapeDigits)
                throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Plays the given file and allows the user to escape by pressing one of the
 given digit.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - name of the file to play.<DD><CODE>escapeDigits</CODE> - a String containing the DTMF digits that allow the
            user to escape.
<DT><B>Returns:</B><DD>the DTMF digit pressed or 0x0 if none was pressed.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="sayDigits(java.lang.String)"><!-- --></A><H3>
sayDigits</H3>
<PRE>
public void <B>sayDigits</B>(java.lang.String&nbsp;digits)
               throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given digit string.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>digits</CODE> - the digit string to say.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="sayDigits(java.lang.String, java.lang.String)"><!-- --></A><H3>
sayDigits</H3>
<PRE>
public char <B>sayDigits</B>(java.lang.String&nbsp;digits,
                      java.lang.String&nbsp;escapeDigits)
               throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given number, returning early if any of the given DTMF number
 are received on the channel.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>digits</CODE> - the digit string to say.<DD><CODE>escapeDigits</CODE> - a String containing the DTMF digits that allow the
            user to escape.
<DT><B>Returns:</B><DD>the DTMF digit pressed or 0x0 if none was pressed.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="sayNumber(java.lang.String)"><!-- --></A><H3>
sayNumber</H3>
<PRE>
public void <B>sayNumber</B>(java.lang.String&nbsp;number)
               throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given number.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>number</CODE> - the number to say.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="sayNumber(java.lang.String, java.lang.String)"><!-- --></A><H3>
sayNumber</H3>
<PRE>
public char <B>sayNumber</B>(java.lang.String&nbsp;number,
                      java.lang.String&nbsp;escapeDigits)
               throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given number, returning early if any of the given DTMF number
 are received on the channel.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>number</CODE> - the number to say.<DD><CODE>escapeDigits</CODE> - a String containing the DTMF digits that allow the
            user to escape.
<DT><B>Returns:</B><DD>the DTMF digit pressed or 0x0 if none was pressed.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="sayPhonetic(java.lang.String)"><!-- --></A><H3>
sayPhonetic</H3>
<PRE>
public void <B>sayPhonetic</B>(java.lang.String&nbsp;text)
                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given character string with phonetics.