📄 getoptioncommand.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:26 CEST 2007 --><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><TITLE>GetOptionCommand (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="GetOptionCommand (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/GetOptionCommand.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/command/GetFullVariableCommand.html" title="class in org.asteriskjava.fastagi.command"><B>PREV CLASS</B></A> <A HREF="../../../../org/asteriskjava/fastagi/command/GetVariableCommand.html" title="class in org.asteriskjava.fastagi.command"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/asteriskjava/fastagi/command/GetOptionCommand.html" target="_top"><B>FRAMES</B></A> <A HREF="GetOptionCommand.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.command</FONT><BR>Class GetOptionCommand</H2><PRE>java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html" title="class in org.asteriskjava.fastagi.command">org.asteriskjava.fastagi.command.AbstractAgiCommand</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.asteriskjava.fastagi.command.GetOptionCommand</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/asteriskjava/fastagi/command/AgiCommand.html" title="interface in org.asteriskjava.fastagi.command">AgiCommand</A></DD></DL><HR><DL><DT><PRE>public class <B>GetOptionCommand</B><DT>extends <A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html" title="class in org.asteriskjava.fastagi.command">AbstractAgiCommand</A></DL></PRE><P>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 this command waits for the specified timeout still waiting for the user to press a digit. Streaming always begins at the beginning.<p> Returns 0 if no digit being pressed, or the ASCII numerical value of the digit if one was pressed, or -1 on error or if the channel was disconnected. <p> Remember, the file extension must not be included in the filename.<P><P><DL><DT><B>Version:</B></DT> <DD>$Id: GetOptionCommand.java 729 2007-05-26 05:16:57Z sprior $</DD><DT><B>Author:</B></DT> <DD>srt</DD><DT><B>See Also:</B><DD><A HREF="../../../../org/asteriskjava/fastagi/command/StreamFileCommand.html" title="class in org.asteriskjava.fastagi.command"><CODE>StreamFileCommand</CODE></A>, <A HREF="../../../../serialized-form.html#org.asteriskjava.fastagi.command.GetOptionCommand">Serialized Form</A></DL><HR><P><!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_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>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/GetOptionCommand.html#GetOptionCommand(java.lang.String, java.lang.String)">GetOptionCommand</A></B>(java.lang.String file, java.lang.String escapeDigits)</CODE><BR> Creates a new GetOptionCommand with a default timeout of 5 seconds.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/GetOptionCommand.html#GetOptionCommand(java.lang.String, java.lang.String, int)">GetOptionCommand</A></B>(java.lang.String file, java.lang.String escapeDigits, int timeout)</CODE><BR> Creates a new GetOptionCommand with the given timeout.</TD></TR></TABLE> <!-- ========== 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> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/GetOptionCommand.html#buildCommand()">buildCommand</A></B>()</CODE><BR> Returns a string suitable to be sent to asterisk.</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/command/GetOptionCommand.html#getEscapeDigits()">getEscapeDigits</A></B>()</CODE><BR> Returns the digits that the user is expected to press.</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/command/GetOptionCommand.html#getFile()">getFile</A></B>()</CODE><BR> Returns the name of the file to stream.</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/command/GetOptionCommand.html#getTimeout()">getTimeout</A></B>()</CODE><BR> Returns the timeout to wait if none of the defined esacpe digits was presses while streaming.</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/command/GetOptionCommand.html#setEscapeDigits(java.lang.String)">setEscapeDigits</A></B>(java.lang.String escapeDigits)</CODE><BR> Sets the digits that the user is expected to press.</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/command/GetOptionCommand.html#setFile(java.lang.String)">setFile</A></B>(java.lang.String file)</CODE><BR> Sets the name of the file to stream.</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/command/GetOptionCommand.html#setTimeout(int)">setTimeout</A></B>(int timeout)</CODE><BR> Sets the timeout to wait if none of the defined esacpe digits was presses while streaming.</TD></TR></TABLE> <A NAME="methods_inherited_from_class_org.asteriskjava.fastagi.command.AbstractAgiCommand"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Methods inherited from class org.asteriskjava.fastagi.command.<A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html" title="class in org.asteriskjava.fastagi.command">AbstractAgiCommand</A></B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -