agireply.html

关于asterisk的java包

<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.asteriskjava.fastagi.reply.AgiReply.SC_SUCCESS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SC_INVALID_OR_UNKNOWN_COMMAND"><!-- --></A><H3>
SC_INVALID_OR_UNKNOWN_COMMAND</H3>
<PRE>
static final int <B>SC_INVALID_OR_UNKNOWN_COMMAND</B></PRE>
<DL>
<DD>Status code (510) indicating Asterisk was unable to process the
 AgiCommand because there is no command with the given name available.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.asteriskjava.fastagi.reply.AgiReply.SC_INVALID_OR_UNKNOWN_COMMAND">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SC_INVALID_COMMAND_SYNTAX"><!-- --></A><H3>
SC_INVALID_COMMAND_SYNTAX</H3>
<PRE>
static final int <B>SC_INVALID_COMMAND_SYNTAX</B></PRE>
<DL>
<DD>Status code (520) indicating Asterisk was unable to process the
 AgiCommand because the syntax used was not correct. This is most likely
 due to missing required parameters or additional parameters sent that are
 not understood.<p>
 Ensure proper quoting of the parameters when you receive this status
 code.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.asteriskjava.fastagi.reply.AgiReply.SC_INVALID_COMMAND_SYNTAX">Constant Field Values</A></DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getFirstLine()"><!-- --></A><H3>
getFirstLine</H3>
<PRE>
java.lang.String <B>getFirstLine</B>()</PRE>
<DL>
<DD>Returns the first line of the raw reply.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the first line of the raw reply.</DL>
</DD>
</DL>
<HR>

<A NAME="getLines()"><!-- --></A><H3>
getLines</H3>
<PRE>
java.util.List&lt;java.lang.String&gt; <B>getLines</B>()</PRE>
<DL>
<DD>Returns a List containing the lines of the raw reply.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a List containing the lines of the raw reply.</DL>
</DD>
</DL>
<HR>

<A NAME="getResultCode()"><!-- --></A><H3>
getResultCode</H3>
<PRE>
int <B>getResultCode</B>()</PRE>
<DL>
<DD>Returns the return code (the result as int).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the return code or -1 if the result is not an int.</DL>
</DD>
</DL>
<HR>

<A NAME="getResultCodeAsChar()"><!-- --></A><H3>
getResultCodeAsChar</H3>
<PRE>
char <B>getResultCodeAsChar</B>()</PRE>
<DL>
<DD>Returns the return code as character.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the return code as character.</DL>
</DD>
</DL>
<HR>

<A NAME="getResult()"><!-- --></A><H3>
getResult</H3>
<PRE>
java.lang.String <B>getResult</B>()</PRE>
<DL>
<DD>Returns the result, that is the part directly following the "result="
 string.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the result.</DL>
</DD>
</DL>
<HR>

<A NAME="getStatus()"><!-- --></A><H3>
getStatus</H3>
<PRE>
int <B>getStatus</B>()</PRE>
<DL>
<DD>Returns the status code.<p>
 Supported status codes are:
 <ul>
 <li>200 Success
 <li>510 Invalid or unknown command
 <li>520 Invalid command syntax
 </ul>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the status code.</DL>
</DD>
</DL>
<HR>

<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
getAttribute</H3>
<PRE>
java.lang.String <B>getAttribute</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Returns an additional attribute contained in the reply.<p>
 For example the reply to the StreamFileCommand contains an additional
 endpos attribute indicating the frame where the playback was stopped.
 This can be retrieved by calling getAttribute("endpos") on the
 corresponding reply.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the attribute to retrieve. The name is case
            insensitive.
<DT><B>Returns:</B><DD>the value of the attribute or <code>null</code> if it is not
         set.</DL>
</DD>
</DL>
<HR>

<A NAME="getExtra()"><!-- --></A><H3>
getExtra</H3>
<PRE>
java.lang.String <B>getExtra</B>()</PRE>
<DL>
<DD>Returns the text in parenthesis contained in this reply.<p>
 The meaning of this property depends on the command sent. Sometimes it
 contains a flag like "timeout" or "hangup" or - in case of the
 GetVariableCommand - the value of the variable.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the text in the parenthesis or <code>null</code> if not set.</DL>
</DD>
</DL>
<HR>

<A NAME="getSynopsis()"><!-- --></A><H3>
getSynopsis</H3>
<PRE>
java.lang.String <B>getSynopsis</B>()</PRE>
<DL>
<DD>Returns the synopsis of the command sent if Asterisk expected a different
 syntax (getStatus() == SC_INVALID_COMMAND_SYNTAX).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the synopsis of the command sent, <code>null</code> if there
         were no syntax errors.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsage()"><!-- --></A><H3>
getUsage</H3>
<PRE>
java.lang.String <B>getUsage</B>()</PRE>
<DL>
<DD>Returns the usage of the command sent if Asterisk expected a different
 syntax (getStatus() == SC_INVALID_COMMAND_SYNTAX).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the usage of the command sent, <code>null</code> if there were
         no syntax errors.</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/AgiReply.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;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/asteriskjava/fastagi/reply/AgiReply.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="AgiReply.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&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>