snow/asternet
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
asternet/docs/html/T_AsterNET_Manager_Action_OriginateAction.htm

81 lines
24 KiB
HTML
Raw Normal View History

add sandcastle generated documentation for github pages
2016-10-03 09:15:07 +00:00
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>OriginateAction Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="OriginateAction class" /><meta name="System.Keywords" content="AsterNET.Manager.Action.OriginateAction class" /><meta name="System.Keywords" content="OriginateAction class, about OriginateAction class" /><meta name="Microsoft.Help.F1" content="AsterNET.Manager.Action.OriginateAction" /><meta name="Microsoft.Help.Id" content="T:AsterNET.Manager.Action.OriginateAction" /><meta name="Description" content="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. If you want to connect to an extension use the properties context, exten and priority." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Action" /><meta name="file" content="T_AsterNET_Manager_Action_OriginateAction" /><meta name="guid" content="T_AsterNET_Manager_Action_OriginateAction" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">AsterNet Class Library (Sandcastle documentation)<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title="AsterNet Class Library (Sandcastle documentation)" tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_Manager_Action.htm" title="AsterNET.Manager.Action" tocid="N_AsterNET_Manager_Action">AsterNET.Manager.Action</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Action_OriginateAction.htm" title="OriginateAction Class" tocid="T_AsterNET_Manager_Action_OriginateAction">OriginateAction Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_Manager_Action_OriginateAction__ctor.htm" title="OriginateAction Constructor " tocid="M_AsterNET_Manager_Action_OriginateAction__ctor">OriginateAction Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Methods_T_AsterNET_Manager_Action_OriginateAction.htm" title="OriginateAction Methods" tocid="Methods_T_AsterNET_Manager_Action_OriginateAction">OriginateAction Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Properties_T_AsterNET_Manager_Action_OriginateAction.htm" title="OriginateAction Properties" tocid="Properties_T_AsterNET_Manager_Action_OriginateAction">OriginateAction Properties</a></div></div><
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.<br />
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.<br />
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.<br />
If you set async to true Asterisk reports an OriginateSuccess-
and OriginateFailureEvents. The action id of these events equals the action
id of this OriginateAction.
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST7475DC3_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7475DC3_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="T_AsterNET_Manager_Action_ManagerAction.htm">AsterNET.Manager.Action<span id="LST7475DC3_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7475DC3_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ManagerAction</a><br />    <a href="T_AsterNET_Manager_Action_ManagerActionEvent.htm">AsterNET.Manager.Action<span id="LST7475DC3_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7475DC3_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ManagerActionEvent</a><br />      <span class="selflink">AsterNET.Manager.Action<span id="LST7475DC3_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7475DC3_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>OriginateAction</span><br /></div><p> </p><strong>Namespace:</strong> <a href="N_AsterNET_Manager_Action.htm">AsterNET.Manager.Action</a><br /><strong>Assembly:</strong> AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cs','1','4');return false;">C#</a></div><div id="ID1EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','vb','2','4');return false;">VB</a></div><div id="ID1EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cpp','3','4');return false;">C++</a></div><div id="ID1EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID1EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID1EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">OriginateAction</span> : <span class="identifier">ManagerActionEvent</span>,
<span class="identifier">IActionVariable</span></pre></div><div id="ID1EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">OriginateAction</span>
<span class="keyword">Inherits</span> <span class="identifier">ManagerActionEvent</span>
<span class="keyword">Implements</span> <span class="identifier">IActionVariable</span></pre></div><div id="ID1EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">OriginateAction</span> : <span class="keyword">public</span> <span class="identifier">ManagerActionEvent</span>,
<span class="identifier">IActionVariable</span></pre></div><div id="ID1EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">OriginateAction</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">ManagerActionEvent</span>
<span class="keyword">interface</span> <span class="identifier">IActionVariable</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">OriginateAction</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_OriginateAction__ctor.htm">OriginateAction</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">OriginateAction</span> class</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID4RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_OriginateAction_ActionCompleteEventClass.htm">ActionCompleteEventClass</a></td><td> (Overrides <a href="M_AsterNET_Manager_Action_ManagerActionEvent_ActionCompleteEventClass.htm">ManagerActionEvent<span id="LST7475DC3_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7475DC3_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ActionCompleteEventClass<span id="LST7475DC3_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7475DC3_5?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">Serves as a hash function for a particular type. </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_OriginateAction_GetVariable.htm">GetVariable</a></td><td><div class="summary">
Gets a variable on the originated call. Replaces any existing variable with the same name.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_OriginateAction_GetVariables.htm">GetVariables</a></td><td><div class="summary">
Get the variables dictionary to set on the originated call.
</div></td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_OriginateAction_SetVariable.htm">SetVariable</a></td><td><div class="summary">
Sets a variable dictionary on the originated call. Replaces any existing variable with the same name.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_OriginateAction_SetVariables.htm">SetVariables</a></td><td><div class="summary">
Set the variables dictionary to set on the originated call.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_Manager_Action_ManagerAction_ToString.htm">ToString</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID5RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Account.htm">Account</a></td><td><div class="summary">
Get/Set the account code to use for the originated call.
The account code is included in the call detail record generated for this call and will be used for billing.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Action.htm">Action</a></td><td><div class="summary">
Get the name of this action, i.e. "Originate".
</div> (Overrides <a href="P_AsterNET_Manager_Action_ManagerAction_Action.htm">ManagerAction<span id="LST7475DC3_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7475DC3_6?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Action</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_ActionId.htm">ActionId</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Application.htm">Application</a></td><td><div class="summary">
Get/Set Application to use on connect (use Data for parameters)
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Async.htm">Async</a></td><td><div class="summary">
Get/Set true if this is a fast origination.<br />
For the origination to be asynchronous (allows multiple calls to be generated without waiting for a response).
<br />
Will send OriginateSuccess- and OriginateFailureEvents.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_CallerId.htm">CallerId</a></td><td><div class="summary">
Get/Set the caller id to set on the outgoing channel.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Channel.htm">Channel</a></td><td><div class="summary">
Get/Set Channel on which to originate the call (The same as you specify in the Dial application command)<br />
This property is required.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Context.htm">Context</a></td><td><div class="summary">
Get/Set the name of the context of the extension to connect to.
If you set the context you also have to set the exten and priority properties.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Data.htm">Data</a></td><td><div class="summary">
Get/Set the parameters to pass to the application.
Data if Application parameter is user
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Exten.htm">Exten</a></td><td><div class="summary">
Get/Ser the extension to connect to.
If you set the extension you also have to set the context and priority properties.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Priority.htm">Priority</a></td><td><div class="summary">
Get /Set the priority of the extension to connect to.
If you set the priority you also have to set the context and exten properties.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_ProxyKey.htm">ProxyKey</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_ManagerAction_Server.htm">Server</a></td><td><div class="summary">
Specify a server to which to send your commands (x.x.x.x or hostname).<br />
This should match the server name specified in your config file's "host" entry.
If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations.
</div> (Inherited from <a href="T_AsterNET_Manager_Action_ManagerAction.htm">ManagerAction</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Timeout.htm">Timeout</a></td><td><div class="summary">
Get/Set the timeout for the origination in milliseconds.<br />
The channel must be answered within this time, otherwise the origination
is considered to have failed and an OriginateFailureEvent is generated.<br />
If not set, Asterisk assumes a default value of 30000 meaning 30 seconds.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Action_OriginateAction_Variable.htm">Variable</a></td><td> <strong>Obsolete. </strong><div class="summary">
Get/Set the variables to set on the originated call.<br />
Variable assignments are of the form "VARNAME=VALUE". You can specify
multiple variable assignments separated by the '|' character.<br />
Example: "VAR1=abc|VAR2=def" sets the channel variables VAR1 to "abc" and VAR2 to "def".
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID6RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_AsterNET_Manager_Action.htm">AsterNET.Manager.Action Namespace</a></div><div class="seeAlsoStyle"><span class="nolink">[!:AsterNET.Manager.Event.OriginateSuccessEvent]</span></div><div class="seeAlsoStyle"><span class="nolink">[!:AsterNET.Manager.Event.OriginateFailureEvent]</span></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
Reference in a new issue Copy permalink