agirequestimpl.html

关于asterisk的java包

 agi://host[:port][/script].</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/internal/AgiRequestImpl.html#getScript()">getScript</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the script to execute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/internal/AgiRequestImpl.html#getType()">getType</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the type of the channel, for example "SIP".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/internal/AgiRequestImpl.html#getUniqueId()">getUniqueId</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the unqiue id of the channel.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/internal/AgiRequestImpl.html#toString()">toString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ 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="getRequest()"><!-- --></A><H3>
getRequest</H3>
<PRE>
public java.util.Map&lt;java.lang.String,java.lang.String&gt; <B>getRequest</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getRequest()">AgiRequest</A></CODE></B></DD>
<DD>Returns a Map containing the raw request name/value pairs.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getRequest()">getRequest</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Map contain raw request name/value pairs.</DL>
</DD>
</DL>
<HR>

<A NAME="getScript()"><!-- --></A><H3>
getScript</H3>
<PRE>
public java.lang.String <B>getScript</B>()</PRE>
<DL>
<DD>Returns the name of the script to execute.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getScript()">getScript</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the name of the script to execute.</DL>
</DD>
</DL>
<HR>

<A NAME="getRequestURL()"><!-- --></A><H3>
getRequestURL</H3>
<PRE>
public java.lang.String <B>getRequestURL</B>()</PRE>
<DL>
<DD>Returns the full URL of the request in the form
 agi://host[:port][/script].
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getRequestURL()">getRequestURL</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the full URL of the request in the form
         agi://host[:port][/script].</DL>
</DD>
</DL>
<HR>

<A NAME="getChannel()"><!-- --></A><H3>
getChannel</H3>
<PRE>
public java.lang.String <B>getChannel</B>()</PRE>
<DL>
<DD>Returns the name of the channel.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getChannel()">getChannel</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the name of the channel.</DL>
</DD>
</DL>
<HR>

<A NAME="getUniqueId()"><!-- --></A><H3>
getUniqueId</H3>
<PRE>
public java.lang.String <B>getUniqueId</B>()</PRE>
<DL>
<DD>Returns the unqiue id of the channel.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getUniqueId()">getUniqueId</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the unqiue id of the channel.</DL>
</DD>
</DL>
<HR>

<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public java.lang.String <B>getType</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getType()">AgiRequest</A></CODE></B></DD>
<DD>Returns the type of the channel, for example "SIP".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getType()">getType</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the type of the channel, for example "SIP".</DL>
</DD>
</DL>
<HR>

<A NAME="getLanguage()"><!-- --></A><H3>
getLanguage</H3>
<PRE>
public java.lang.String <B>getLanguage</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getLanguage()">AgiRequest</A></CODE></B></DD>
<DD>Returns the language set for the current channel, for example "en".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getLanguage()">getLanguage</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the language set for the current channel, for example "en".</DL>
</DD>
</DL>
<HR>

<A NAME="getCallerId()"><!-- --></A><H3>
getCallerId</H3>
<PRE>
public java.lang.String <B>getCallerId</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getCallerId()">AgiRequest</A></CODE></B></DD>
<DD>Returns the Caller*ID number, for example "1234".<p>
 Note: even with Asterisk 1.0 is contains only the numerical part
 of the Caller ID.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getCallerId()">getCallerId</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Caller*ID number, for example "1234", if no Caller*ID is set or it
         is "unknown" <code>null</code> is returned.</DL>
</DD>
</DL>
<HR>

<A NAME="getCallerIdNumber()"><!-- --></A><H3>
getCallerIdNumber</H3>
<PRE>
public java.lang.String <B>getCallerIdNumber</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getCallerIdNumber()">AgiRequest</A></CODE></B></DD>
<DD>Returns the Caller*ID number, for example "1234".<p>
 Note: even with Asterisk 1.0 is contains only the numerical part
 of the Caller ID.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getCallerIdNumber()">getCallerIdNumber</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Caller*ID number, for example "1234", if no Caller*ID is set or it
         is "unknown" <code>null</code> is returned.</DL>
</DD>
</DL>
<HR>

<A NAME="getCallerIdName()"><!-- --></A><H3>
getCallerIdName</H3>
<PRE>
public java.lang.String <B>getCallerIdName</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getCallerIdName()">AgiRequest</A></CODE></B></DD>
<DD>Returns the the Caller*ID Name, for example "John Doe".
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getCallerIdName()">getCallerIdName</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the the Caller*ID Name, for example "John Doe", if no Caller*ID
         Name is set or it is "unknown" <code>null</code> is returned.</DL>
</DD>
</DL>
<HR>

<A NAME="getDnid()"><!-- --></A><H3>
getDnid</H3>
<PRE>
public java.lang.String <B>getDnid</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getDnid()">AgiRequest</A></CODE></B></DD>
<DD>Returns the number, that has been dialed by the user.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getDnid()">getDnid</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the dialed number, if no DNID is available or it is "unknown"
         <code>null</code> is returned.</DL>
</DD>
</DL>
<HR>

<A NAME="getRdnis()"><!-- --></A><H3>
getRdnis</H3>
<PRE>
public java.lang.String <B>getRdnis</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getRdnis()">AgiRequest</A></CODE></B></DD>
<DD>If this call has been forwared, the number of the person doing the
 redirect is returned (Redirected dialed number identification service).<p>
 This is usally only only available on PRI.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getRdnis()">getRdnis</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the number of the person doing the redirect, , if no RDNIS is
         available or it is "unknown" <code>null</code> is returned.</DL>
</DD>
</DL>
<HR>

<A NAME="getContext()"><!-- --></A><H3>
getContext</H3>
<PRE>
public java.lang.String <B>getContext</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getContext()">AgiRequest</A></CODE></B></DD>
<DD>Returns the context in the dial plan from which the AGI script was
 called.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getContext()">getContext</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the context in the dial plan from which the AGI script was
         called.</DL>
</DD>
</DL>
<HR>

<A NAME="getExtension()"><!-- --></A><H3>
getExtension</H3>
<PRE>
public java.lang.String <B>getExtension</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getExtension()">AgiRequest</A></CODE></B></DD>
<DD>Returns the extension in the dial plan from which the AGI script was
 called.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getExtension()">getExtension</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the extension in the dial plan from which the AGI script was
         called.</DL>
</DD>
</DL>
<HR>

<A NAME="getPriority()"><!-- --></A><H3>
getPriority</H3>
<PRE>
public java.lang.Integer <B>getPriority</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getPriority()">AgiRequest</A></CODE></B></DD>
<DD>Returns the priority of the dial plan entry the AGI script was
 called from.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html#getPriority()">getPriority</A></CODE> in interface <CODE><A HREF="../../../../org/asteriskjava/fastagi/AgiRequest.html" title="interface in org.asteriskjava.fastagi">AgiRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the priority of the dial plan entry the AGI script was
         called from.</DL>
</DD>