agioperations.html

关于asterisk的java包

<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - the text 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="sayPhonetic(java.lang.String, java.lang.String)"><!-- --></A><H3>
sayPhonetic</H3>
<PRE>
public char <B>sayPhonetic</B>(java.lang.String&nbsp;text,
                        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 character string with phonetics, returning early if any of
 the given DTMF number are received on the channel.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - the text 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="sayAlpha(java.lang.String)"><!-- --></A><H3>
sayAlpha</H3>
<PRE>
public void <B>sayAlpha</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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - the text 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="sayAlpha(java.lang.String, java.lang.String)"><!-- --></A><H3>
sayAlpha</H3>
<PRE>
public char <B>sayAlpha</B>(java.lang.String&nbsp;text,
                     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 character string, returning early if any of the given DTMF
 number are received on the channel.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - the text 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="sayTime(long)"><!-- --></A><H3>
sayTime</H3>
<PRE>
public void <B>sayTime</B>(long&nbsp;time)
             throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given time.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>time</CODE> - the time to say in seconds since 00:00:00 on January 1, 1970.
<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="sayTime(long, java.lang.String)"><!-- --></A><H3>
sayTime</H3>
<PRE>
public char <B>sayTime</B>(long&nbsp;time,
                    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 time, returning early if any of the given DTMF number are
 received on the channel.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>time</CODE> - the time to say in seconds since 00:00:00 on January 1, 1970.<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="getVariable(java.lang.String)"><!-- --></A><H3>
getVariable</H3>
<PRE>
public java.lang.String <B>getVariable</B>(java.lang.String&nbsp;name)
                             throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Returns the value of the given channel variable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the variable to retrieve.
<DT><B>Returns:</B><DD>the value of the given variable or <code>null</code> if not
         set.
<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="setVariable(java.lang.String, java.lang.String)"><!-- --></A><H3>
setVariable</H3>
<PRE>
public void <B>setVariable</B>(java.lang.String&nbsp;name,
                        java.lang.String&nbsp;value)
                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Sets the value of the given channel variable to a new value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the variable to retrieve.<DD><CODE>value</CODE> - the new value to set.
<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="waitForDigit(int)"><!-- --></A><H3>
waitForDigit</H3>
<PRE>
public char <B>waitForDigit</B>(int&nbsp;timeout)
                  throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Waits up to 'timeout' milliseconds to receive a DTMF digit.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - timeout the milliseconds to wait for the channel to
            receive a DTMF digit, -1 will wait forever.
<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="getFullVariable(java.lang.String)"><!-- --></A><H3>
getFullVariable</H3>
<PRE>
public java.lang.String <B>getFullVariable</B>(java.lang.String&nbsp;name)
                                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Returns the value of the current channel variable, unlike getVariable()
 this method understands complex variable names and builtin variables.
 <p>
 You can also use this method to use custom Asterisk functions. Syntax is
 "func(args)".
 <p>
 Available since Asterisk 1.2.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the variable to retrieve.
<DT><B>Returns:</B><DD>the value of the given variable or <code>null</code> if not
         set.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE><DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFullVariable(java.lang.String, java.lang.String)"><!-- --></A><H3>
getFullVariable</H3>
<PRE>
public java.lang.String <B>getFullVariable</B>(java.lang.String&nbsp;name,
                                        java.lang.String&nbsp;channel)
                                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Returns the value of the given channel variable.
 <p>
 Available since Asterisk 1.2.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the variable to retrieve.<DD><CODE>channel</CODE> - the name of the channel.
<DT><B>Returns:</B><DD>the value of the given variable or <code>null</code> if not
         set.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE><DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="sayDateTime(long)"><!-- --></A><H3>
sayDateTime</H3>
<PRE>
public void <B>sayDateTime</B>(long&nbsp;time)
                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given time.
 <p>
 Available since Asterisk 1.2.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>time</CODE> - the time to say in seconds elapsed since 00:00:00 on January
            1, 1970, Coordinated Universal Time (UTC)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></CODE><DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="sayDateTime(long, java.lang.String)"><!-- --></A><H3>
sayDateTime</H3>
<PRE>
public char <B>sayDateTime</B>(long&nbsp;time,
                        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 time and allows interruption by one of the given escape
 digits.
 <p>
 Available since Asterisk 1.2.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>time</CODE> - the time to say in seconds elapsed since 00:00:00 on January
            1, 1970, Coordinated Universal Time (UTC)<DD><CODE>escapeDigits</CODE> - the digits that allow the user to interrupt this
            command or <code>null</code> for none.
<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><DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="sayDateTime(long, java.lang.String, java.lang.String)"><!-- --></A><H3>
sayDateTime</H3>
<PRE>
public char <B>sayDateTime</B>(long&nbsp;time,
                        java.lang.String&nbsp;escapeDigits,
                        java.lang.String&nbsp;format)
                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given time in the given format and allows interruption by one of
 the given escape digits.
 <p>
 Available since Asterisk 1.2.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>time</CODE> - the time to say in seconds elapsed since 00:00:00 on January
            1, 1970, Coordinated Universal Time (UTC)<DD><CODE>escapeDigits</CODE> - the digits that allow the user to interrupt this
            command or <code>null</code> for none.<DD><CODE>format</CODE> - the format the time should be said in
<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><DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="sayDateTime(long, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
sayDateTime</H3>
<PRE>
public char <B>sayDateTime</B>(long&nbsp;time,
                        java.lang.String&nbsp;escapeDigits,
                        java.lang.String&nbsp;format,
                        java.lang.String&nbsp;timezone)
                 throws <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi">AgiException</A></PRE>
<DL>
<DD>Says the given time in the given format and timezone and allows
 interruption by one of the given escape digits.
 <p>
 Available since Asterisk 1.2.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>time</CODE> - the time to say in seconds elapsed since 00:00:00 on January
            1, 1970, Coordinated Universal Time (UTC)<DD><CODE>escapeDigits</CODE> - the digits that allow the user to