📄 agichannel.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.6.0_02) on Wed Sep 05 17:57:30 CEST 2007 --><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><TITLE>AgiChannel (Asterisk-Java 0.3.1 API)</TITLE><META NAME="date" CONTENT="2007-09-05"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ if (location.href.indexOf('is-external=true') == -1) { parent.document.title="AgiChannel (Asterisk-Java 0.3.1 API)"; }}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><HR><!-- ========= 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="class-use/AgiChannel.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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>Asterisk-Java</EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../org/asteriskjava/fastagi/AbstractMappingStrategy.html" title="class in org.asteriskjava.fastagi"><B>PREV CLASS</B></A> <A HREF="../../../org/asteriskjava/fastagi/AgiException.html" title="class in org.asteriskjava.fastagi"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?org/asteriskjava/fastagi/AgiChannel.html" target="_top"><B>FRAMES</B></A> <A HREF="AgiChannel.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <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.asteriskjava.fastagi</FONT><BR>Interface AgiChannel</H2><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/asteriskjava/fastagi/internal/AgiChannelImpl.html" title="class in org.asteriskjava.fastagi.internal">AgiChannelImpl</A></DD></DL><HR><DL><DT><PRE>public interface <B>AgiChannel</B></DL></PRE><P>Provides the functionality to send AgiCommands to Asterisk while handling an AgiRequest. <p> This interface is supposed to be used by AgiScripts for interaction with the Asterisk server.<P><P><DL><DT><B>Version:</B></DT> <DD>$Id: AgiChannel.java 633 2007-03-25 17:02:18Z srt $</DD><DT><B>Author:</B></DT> <DD>srt</DD></DL><HR><P><!-- ========== 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/asteriskjava/fastagi/AgiChannel.html#answer()">answer</A></B>()</CODE><BR> Answers the channel.</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/asteriskjava/fastagi/AgiChannel.html#controlStreamFile(java.lang.String)">controlStreamFile</A></B>(java.lang.String file)</CODE><BR> Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> char</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#controlStreamFile(java.lang.String, java.lang.String)">controlStreamFile</A></B>(java.lang.String file, java.lang.String escapeDigits)</CODE><BR> Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> char</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#controlStreamFile(java.lang.String, java.lang.String, int)">controlStreamFile</A></B>(java.lang.String file, java.lang.String escapeDigits, int offset)</CODE><BR> Plays the given file allowing the user to control the streaming by using "#" for forward and "*" for rewind.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> char</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#controlStreamFile(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String)">controlStreamFile</A></B>(java.lang.String file, java.lang.String escapeDigits, int offset, java.lang.String forwardDigit, java.lang.String rewindDigit, java.lang.String pauseDigit)</CODE><BR> Plays the given file allowing the user to control the streaming by using forwardDigit for forward, rewindDigit for rewind and pauseDigit for pause.</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/asteriskjava/fastagi/AgiChannel.html#databaseDel(java.lang.String, java.lang.String)">databaseDel</A></B>(java.lang.String family, java.lang.String key)</CODE><BR> Deletes an entry in the Asterisk database for a given family and key.</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/asteriskjava/fastagi/AgiChannel.html#databaseDelTree(java.lang.String)">databaseDelTree</A></B>(java.lang.String family)</CODE><BR> Deletes a whole family of entries in the Asterisk database.</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/asteriskjava/fastagi/AgiChannel.html#databaseDelTree(java.lang.String, java.lang.String)">databaseDelTree</A></B>(java.lang.String family, java.lang.String keytree)</CODE><BR> Deletes all entries of a given family in the Asterisk database that have a key that starts with a given prefix.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#databaseGet(java.lang.String, java.lang.String)">databaseGet</A></B>(java.lang.String family, java.lang.String key)</CODE><BR> Retrieves an entry in the Asterisk database for a given family and key.</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/asteriskjava/fastagi/AgiChannel.html#databasePut(java.lang.String, java.lang.String, java.lang.String)">databasePut</A></B>(java.lang.String family, java.lang.String key, java.lang.String value)</CODE><BR> Adds or updates an entry in the Asterisk database for a given family, key, and value.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#exec(java.lang.String)">exec</A></B>(java.lang.String application)</CODE><BR> Executes the given command.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#exec(java.lang.String, java.lang.String)">exec</A></B>(java.lang.String application, java.lang.String options)</CODE><BR> Executes the given command.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#getChannelStatus()">getChannelStatus</A></B>()</CODE><BR> Returns the status of the channel.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#getData(java.lang.String)">getData</A></B>(java.lang.String file)</CODE><BR> Plays the given file and waits for the user to enter DTMF digits until he presses '#'.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#getData(java.lang.String, long)">getData</A></B>(java.lang.String file, long timeout)</CODE><BR> Plays the given file and waits for the user to enter DTMF digits until he presses '#' or the timeout occurs.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#getData(java.lang.String, long, int)">getData</A></B>(java.lang.String file, long timeout, int maxDigits)</CODE><BR> 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.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#getFullVariable(java.lang.String)">getFullVariable</A></B>(java.lang.String name)</CODE><BR> Returns the value of the current channel variable, unlike getVariable() this method understands complex variable names and builtin variables.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../org/asteriskjava/fastagi/AgiChannel.html#getFullVariable(java.lang.String, java.lang.String)">getFullVariable</A></B>(java.lang.String name, java.lang.String channel)</CODE><BR> Returns the value of the given channel variable.</TD>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -