📄 originateaction.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:28 CEST 2007 --><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><TITLE>OriginateAction (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="OriginateAction (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/OriginateAction.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/manager/action/MonitorAction.html" title="class in org.asteriskjava.manager.action"><B>PREV CLASS</B></A> <A HREF="../../../../org/asteriskjava/manager/action/ParkAction.html" title="class in org.asteriskjava.manager.action"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/asteriskjava/manager/action/OriginateAction.html" target="_top"><B>FRAMES</B></A> <A HREF="OriginateAction.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.manager.action</FONT><BR>Class OriginateAction</H2><PRE>java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/asteriskjava/manager/action/AbstractManagerAction.html" title="class in org.asteriskjava.manager.action">org.asteriskjava.manager.action.AbstractManagerAction</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.asteriskjava.manager.action.OriginateAction</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A>, <A HREF="../../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A></DD></DL><HR><DL><DT><PRE>public class <B>OriginateAction</B><DT>extends <A HREF="../../../../org/asteriskjava/manager/action/AbstractManagerAction.html" title="class in org.asteriskjava.manager.action">AbstractManagerAction</A><DT>implements <A HREF="../../../../org/asteriskjava/manager/action/EventGeneratingAction.html" title="interface in org.asteriskjava.manager.action">EventGeneratingAction</A></DL></PRE><P>The OriginateAction generates an outgoing call to the extension in the given context with the given priority or to a given application with optional parameters.<p> If you want to connect to an extension use the properties context, exten and priority. If you want to connect to an application use the properties application and data if needed. Note that no call detail record will be written when directly connecting to an application, so it may be better to connect to an extension that starts the application you wish to connect to.<p> The response to this action is sent when the channel has been answered and asterisk starts connecting it to the given extension. So be careful not to choose a too short timeout when waiting for the response.<p> If you set async to <code>true</code> Asterisk reports an OriginateSuccess- and OriginateFailureEvents. The action id of these events equals the action id of this OriginateAction.<P><P><DL><DT><B>Version:</B></DT> <DD>$Id: OriginateAction.java 858 2007-07-11 09:54:20Z srt $</DD><DT><B>Author:</B></DT> <DD>srt</DD><DT><B>See Also:</B><DD><A HREF="../../../../org/asteriskjava/manager/event/OriginateResponseEvent.html" title="class in org.asteriskjava.manager.event"><CODE>OriginateResponseEvent</CODE></A>, <A HREF="../../../../serialized-form.html#org.asteriskjava.manager.action.OriginateAction">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/manager/action/OriginateAction.html#OriginateAction()">OriginateAction</A></B>()</CODE><BR> </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/manager/action/OriginateAction.html#getAccount()">getAccount</A></B>()</CODE><BR> Returns the account code to use for the originated call.</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/manager/action/OriginateAction.html#getAction()">getAction</A></B>()</CODE><BR> Returns the name of this action, i.e.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.Class</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/OriginateAction.html#getActionCompleteEventClass()">getActionCompleteEventClass</A></B>()</CODE><BR> Returns the event type that indicates that Asterisk is finished sending response events for this action.</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/manager/action/OriginateAction.html#getApplication()">getApplication</A></B>()</CODE><BR> Returns the name of the application to connect to.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.Boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/OriginateAction.html#getAsync()">getAsync</A></B>()</CODE><BR> Returns true if this is a fast origination.</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/manager/action/OriginateAction.html#getCallerId()">getCallerId</A></B>()</CODE><BR> Returns the caller id to set on the outgoing channel.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.Integer</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/OriginateAction.html#getCallingPres()">getCallingPres</A></B>()</CODE><BR> Returns the calling presentation for the outgoing 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/manager/action/OriginateAction.html#getChannel()">getChannel</A></B>()</CODE><BR> Returns the name of the channel to connect to the outgoing call.</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/manager/action/OriginateAction.html#getContext()">getContext</A></B>()</CODE><BR> Returns the name of the context of the extension to connect to.</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/manager/action/OriginateAction.html#getData()">getData</A></B>()</CODE><BR> Returns the parameters to pass to the application.</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/manager/action/OriginateAction.html#getExten()">getExten</A></B>()</CODE><BR> Returns the extension to connect to.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.Integer</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/OriginateAction.html#getPriority()">getPriority</A></B>()</CODE><BR> Returns the priority of the extension to connect to.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.Long</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/OriginateAction.html#getTimeout()">getTimeout</A></B>()</CODE><BR> Returns the timeout for the origination.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Map<java.lang.String,java.lang.String></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/OriginateAction.html#getVariables()">getVariables</A></B>()</CODE><BR> Returns the variables to set on the originated call.</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/manager/action/OriginateAction.html#setAccount(java.lang.String)">setAccount</A></B>(java.lang.String account)</CODE><BR> Sets the account code to use for the originated call.</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/manager/action/OriginateAction.html#setApplication(java.lang.String)">setApplication</A></B>(java.lang.String application)</CODE><BR> Sets the name of the application to connect to.</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/manager/action/OriginateAction.html#setAsync(java.lang.Boolean)">setAsync</A></B>(java.lang.Boolean async)</CODE><BR> Set to true for fast origination.</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/manager/action/OriginateAction.html#setCallerId(java.lang.String)">setCallerId</A></B>(java.lang.String callerId)</CODE><BR> Sets the caller id to set on the outgoing 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/manager/action/OriginateAction.html#setCallingPres(java.lang.Integer)">setCallingPres</A></B>(java.lang.Integer callingPres)</CODE><BR> Sets the calling presentation for the outgoing 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/manager/action/OriginateAction.html#setChannel(java.lang.String)">setChannel</A></B>(java.lang.String channel)</CODE><BR> Sets the name of the channel to connect to the outgoing call.</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/manager/action/OriginateAction.html#setContext(java.lang.String)">setContext</A></B>(java.lang.String context)</CODE><BR> Sets the name of the context of the extension to connect to.</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/manager/action/OriginateAction.html#setData(java.lang.String)">setData</A></B>(java.lang.String data)</CODE><BR> Sets the parameters to pass to the application.</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/manager/action/OriginateAction.html#setExten(java.lang.String)">setExten</A></B>(java.lang.String exten)</CODE><BR> Sets the extension to connect to.</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/manager/action/OriginateAction.html#setPriority(java.lang.Integer)">setPriority</A></B>(java.lang.Integer priority)</CODE><BR> Sets the priority of the extension to connect to.</TD>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -