181 lines
39 KiB
HTML
181 lines
39 KiB
HTML
<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>AGIScript Methods</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="AGIScript class, methods" /><meta name="Microsoft.Help.Id" content="Methods.T:AsterNET.FastAGI.AGIScript" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.FastAGI" /><meta name="file" content="Methods_T_AsterNET_FastAGI_AGIScript" /><meta name="guid" content="Methods_T_AsterNET_FastAGI_AGIScript" /><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_FastAGI.htm" title="AsterNET.FastAGI" tocid="N_AsterNET_FastAGI">AsterNET.FastAGI</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_AGIScript.htm" title="AGIScript Class" tocid="T_AsterNET_FastAGI_AGIScript">AGIScript Class</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="Methods_T_AsterNET_FastAGI_AGIScript.htm" title="AGIScript Methods" tocid="Methods_T_AsterNET_FastAGI_AGIScript">AGIScript Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Answer.htm" title="Answer Method " tocid="M_AsterNET_FastAGI_AGIScript_Answer">Answer Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_ControlStreamFile.htm" title="ControlStreamFile Method " tocid="Overload_AsterNET_FastAGI_AGIScript_ControlStreamFile">ControlStreamFile Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_DatabaseDel.htm" title="DatabaseDel Method " tocid="M_AsterNET_FastAGI_AGIScript_DatabaseDel">DatabaseDel Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_DatabaseDelTree.htm" title="DatabaseDelTree Method " tocid="Overload_AsterNET_FastAGI_AGIScript_DatabaseDelTree">DatabaseDelTree Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_DatabaseGet.htm" title="DatabaseGet Method " tocid="M_AsterNET_FastAGI_AGIScript_DatabaseGet">DatabaseGet Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_DatabasePut.htm" title="DatabasePut Method " tocid="M_AsterNET_FastAGI_AGIScript_DatabasePut">DatabasePut Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_Exec.htm" title="Exec Method " tocid="Overload_AsterNET_FastAGI_AGIScript_Exec">Exec Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_GetChannelStatus.htm" title="GetChannelStatus Method " tocid="M_AsterNET_FastAGI_AGIScript_GetChannelStatus">GetChannelStatus Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_GetData.htm" title="GetData Method " tocid="Overload_AsterNET_FastAGI_AGIScript_GetData">GetData Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_GetFullVariable.htm" title="GetFullVariable Method " tocid="Overload_AsterNET_FastAGI_AGIScript_GetFullVariable">GetFullVariable Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_GetOption.htm" title="GetOption Method " tocid="Overload_AsterNET_FastAGI_AGIScript_GetOption">GetOption Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_GetVariable.htm" title="GetVariable Method " tocid="M_AsterNET_FastAGI_AGIScript_GetVariable">GetVariable Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Hangup.htm" title="Hangup Method " tocid="M_AsterNET_FastAGI_AGIScript_Hangup">Hangup Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_PlayMusicOnHold.htm" title="PlayMusicOnHold Method " tocid="Overload_AsterNET_FastAGI_AGIScript_PlayMusicOnHold">PlayMusicOnHold Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_RecordFile.htm" title="RecordFile Method " tocid="Overload_AsterNET_FastAGI_AGIScript_RecordFile">RecordFile Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayAlpha.htm" title="SayAlpha Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayAlpha">SayAlpha Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayDateTime.htm" title="SayDateTime Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayDateTime">SayDateTime Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayDigits.htm" title="SayDigits Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayDigits">SayDigits Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayNumber.htm" title="SayNumber Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayNumber">SayNumber Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayPhonetic.htm" title="SayPhonetic Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayPhonetic">SayPhonetic Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SayTime.htm" title="SayTime Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SayTime">SayTime Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Service.htm" title="Service Method " tocid="M_AsterNET_FastAGI_AGIScript_Service">Service Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetAutoHangup.htm" title="SetAutoHangup Method " tocid="M_AsterNET_FastAGI_AGIScript_SetAutoHangup">SetAutoHangup Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetCallerId.htm" title="SetCallerId Method " tocid="M_AsterNET_FastAGI_AGIScript_SetCallerId">SetCallerId Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetContext.htm" title="SetContext Method " tocid="M_AsterNET_FastAGI_AGIScript_SetContext">SetContext Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetExtension.htm" title="SetExtension Method " tocid="M_AsterNET_FastAGI_AGIScript_SetExtension">SetExtension Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_SetPriority.htm" title="SetPriority Method " tocid="Overload_AsterNET_FastAGI_AGIScript_SetPriority">SetPriority Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_SetVariable.htm" title="SetVariable Method " tocid="M_AsterNET_FastAGI_AGIScript_SetVariable">SetVariable Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_StopMusicOnHold.htm" title="StopMusicOnHold Method " tocid="M_AsterNET_FastAGI_AGIScript_StopMusicOnHold">StopMusicOnHold Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_AGIScript_StreamFile.htm" title="StreamFile Method " tocid="Overload_AsterNET_FastAGI_AGIScript_StreamFile">StreamFile Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_Verbose.htm" title="Verbose Method " tocid="M_AsterNET_FastAGI_AGIScript_Verbose">Verbose Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_FastAGI_AGIScript_WaitForDigit.htm" title="WaitForDigit Method " tocid="M_AsterNET_FastAGI_AGIScript_WaitForDigit">WaitForDigit Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize"><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize"></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn">AGIScript Methods</td></tr></table><span class="introStyle"></span><p>The <a href="T_AsterNET_FastAGI_AGIScript.htm">AGIScript</a> type exposes the following members.</p><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" />Methods</span></div><div id="ID0RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_Answer.htm">Answer</a></td><td><div class="summary">
|
||
Answers the channel.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_ControlStreamFile.htm">ControlStreamFile(String)</a></td><td><div class="summary">
|
||
Plays the given file, allowing playback to be interrupted by the given
|
||
digits, if any, and allows the listner to control the stream.<br />
|
||
If offset is provided then the audio will seek to sample offset before play
|
||
starts.<br />
|
||
Returns 0 if playback completes without a 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. <br />
|
||
Remember, the file extension must not be included in the filename.<br />
|
||
Available since Asterisk 1.2
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_ControlStreamFile_1.htm">ControlStreamFile(String, String)</a></td><td><div class="summary">
|
||
Plays the given file, allowing playback to be interrupted by the given
|
||
digits, if any, and allows the listner to control the stream.<br />
|
||
If offset is provided then the audio will seek to sample offset before play
|
||
starts.<br />
|
||
Returns 0 if playback completes without a 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. <br />
|
||
Remember, the file extension must not be included in the filename.<br />
|
||
Available since Asterisk 1.2
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_ControlStreamFile_2.htm">ControlStreamFile(String, String, Int32)</a></td><td><div class="summary">
|
||
Plays the given file, allowing playback to be interrupted by the given
|
||
digits, if any, and allows the listner to control the stream.<br />
|
||
If offset is provided then the audio will seek to sample offset before play
|
||
starts.<br />
|
||
Returns 0 if playback completes without a 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. <br />
|
||
Remember, the file extension must not be included in the filename.<br />
|
||
Available since Asterisk 1.2
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_ControlStreamFile_3.htm">ControlStreamFile(String, String, Int32, String, String, String)</a></td><td><div class="summary">
|
||
Plays the given file, allowing playback to be interrupted by the given
|
||
digits, if any, and allows the listner to control the stream.<br />
|
||
If offset is provided then the audio will seek to sample offset before play
|
||
starts.<br />
|
||
Returns 0 if playback completes without a 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. <br />
|
||
Remember, the file extension must not be included in the filename.<br />
|
||
Available since Asterisk 1.2
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_DatabaseDel.htm">DatabaseDel</a></td><td><div class="summary">
|
||
Deletes an entry in the Asterisk database for a given family and key.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_DatabaseDelTree.htm">DatabaseDelTree(String)</a></td><td><div class="summary">
|
||
Deletes a whole family of entries in the Asterisk database.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_DatabaseDelTree_1.htm">DatabaseDelTree(String, String)</a></td><td><div class="summary">
|
||
Deletes all entries of a given family in the Asterisk database that have a key that starts with a given prefix.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_DatabaseGet.htm">DatabaseGet</a></td><td><div class="summary">
|
||
Retrieves an entry in the Asterisk database for a given family and key.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_DatabasePut.htm">DatabasePut</a></td><td><div class="summary">
|
||
Adds or updates an entry in the Asterisk database for a given family, key and value.
|
||
</div></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;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_Exec.htm">Exec(String)</a></td><td><div class="summary">
|
||
Executes the given command.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_Exec_1.htm">Exec(String, String)</a></td><td><div class="summary">
|
||
Executes the given command.
|
||
</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/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="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetChannelStatus.htm">GetChannelStatus</a></td><td><div class="summary">
|
||
Returns the status of the channel.<br />
|
||
Return values:
|
||
<ul><li>0 Channel is down and available</li><li>1 Channel is down, but reserved</li><li>2 Channel is off hook</li><li>3 Digits (or equivalent) have been dialed</li><li>4 Line is ringing</li><li>5 Remote end is ringing</li><li>6 Line is up</li><li>7 Line is busy</li></ul></div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetData.htm">GetData(String)</a></td><td><div class="summary">
|
||
Plays the given file and waits for the user to enter DTMF digits until he
|
||
presses '#'. The user may interrupt the streaming by starting to enter
|
||
digits.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetData_1.htm">GetData(String, Int64)</a></td><td><div class="summary">
|
||
Plays the given file and waits for the user to enter DTMF digits until he
|
||
presses '#' or the timeout occurs. The user may interrupt the streaming
|
||
by starting to enter digits.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetData_2.htm">GetData(String, Int64, Int32)</a></td><td><div class="summary">
|
||
Plays the given file and waits for the user to enter DTMF digits until he
|
||
presses '#' or the timeout occurs or the maximum number of digits has
|
||
been entered. The user may interrupt the streaming by starting to enter
|
||
digits.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetFullVariable.htm">GetFullVariable(String)</a></td><td><div class="summary">
|
||
Returns the value of the current channel variable, unlike getVariable()
|
||
this method understands complex variable names and builtin variables.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetFullVariable_1.htm">GetFullVariable(String, String)</a></td><td><div class="summary">
|
||
Returns the value of the given channel variable.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></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="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetOption.htm">GetOption(String, String)</a></td><td><div class="summary">
|
||
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
|
||
it waits for the default timeout of 5 seconds still waiting for the user
|
||
to press a digit.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetOption_1.htm">GetOption(String, String, Int32)</a></td><td><div class="summary">
|
||
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
|
||
it waits for the specified timeout still waiting for the user to press a
|
||
digit.
|
||
</div></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="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_GetVariable.htm">GetVariable</a></td><td><div class="summary">
|
||
Returns the value of the given channel variable.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_Hangup.htm">Hangup</a></td><td><div class="summary">
|
||
Hangs the channel up.
|
||
</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="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_PlayMusicOnHold.htm">PlayMusicOnHold<span id="LSTC4341638_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC4341638_0?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a></td><td><div class="summary">
|
||
Plays music on hold from the default music on hold class.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_PlayMusicOnHold_1.htm">PlayMusicOnHold(String)</a></td><td><div class="summary">
|
||
Plays music on hold from the given music on hold class.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_RecordFile.htm">RecordFile(String, String, String, Int32)</a></td><td><div class="summary">
|
||
Record to a file until a given dtmf digit in the sequence is received.<br />
|
||
Returns -1 on hangup or error.<br />
|
||
The format will specify what kind of file will be recorded. The timeout is
|
||
the maximum record time in milliseconds, or -1 for no timeout. Offset samples
|
||
is optional, and if provided will seek to the offset without exceeding the
|
||
end of the file. "maxSilence" is the number of seconds of maxSilence allowed
|
||
before the function returns despite the lack of dtmf digits or reaching
|
||
timeout.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_RecordFile_1.htm">RecordFile(String, String, String, Int32, Int32, Boolean, Int32)</a></td><td><div class="summary">
|
||
Record to a file until a given dtmf digit in the sequence is received.<br />
|
||
Returns -1 on hangup or error.<br />
|
||
The format will specify what kind of file will be recorded. The timeout is
|
||
the maximum record time in milliseconds, or -1 for no timeout. Offset samples
|
||
is optional, and if provided will seek to the offset without exceeding the
|
||
end of the file. "maxSilence" is the number of seconds of maxSilence allowed
|
||
before the function returns despite the lack of dtmf digits or reaching
|
||
timeout.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayAlpha.htm">SayAlpha(String)</a></td><td><div class="summary">
|
||
Says the given character string.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayAlpha_1.htm">SayAlpha(String, String)</a></td><td><div class="summary">
|
||
Says the given character string, returning early if any of the given DTMF
|
||
number are received on the channel.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayDateTime.htm">SayDateTime(Int64)</a></td><td><div class="summary">
|
||
Says the given time.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayDateTime_1.htm">SayDateTime(Int64, String)</a></td><td><div class="summary">
|
||
Says the given time and allows interruption by one of the given escape digits.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayDateTime_2.htm">SayDateTime(Int64, String, String)</a></td><td><div class="summary">
|
||
Says the given time in the given format and allows interruption by one of the given escape digits.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayDateTime_3.htm">SayDateTime(Int64, String, String, String)</a></td><td><div class="summary">
|
||
Says the given time in the given format and timezone and allows interruption by one of the given escape digits.<br />
|
||
Available since Asterisk 1.2.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayDigits.htm">SayDigits(String)</a></td><td><div class="summary">
|
||
Says the given digit string.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayDigits_1.htm">SayDigits(String, String)</a></td><td><div class="summary">
|
||
Says the given number, returning early if any of the given DTMF number
|
||
are received on the channel.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayNumber.htm">SayNumber(String)</a></td><td><div class="summary">
|
||
Says the given number.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayNumber_1.htm">SayNumber(String, String)</a></td><td><div class="summary">
|
||
Says the given number, returning early if any of the given DTMF number
|
||
are received on the channel.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayPhonetic.htm">SayPhonetic(String)</a></td><td><div class="summary">
|
||
Says the given character string with phonetics.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayPhonetic_1.htm">SayPhonetic(String, String)</a></td><td><div class="summary">
|
||
Says the given character string with phonetics, returning early if any of
|
||
the given DTMF number are received on the channel.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayTime.htm">SayTime(Int64)</a></td><td><div class="summary">
|
||
Says the given time.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SayTime_1.htm">SayTime(Int64, String)</a></td><td><div class="summary">
|
||
Says the given time, returning early if any of the given DTMF number are
|
||
received on the channel.
|
||
</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_FastAGI_AGIScript_Service.htm">Service</a></td><td /></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SetAutoHangup.htm">SetAutoHangup</a></td><td><div class="summary">
|
||
Cause the channel to automatically hangup at the given number of seconds in the future.<br />
|
||
0 disables the autohangup feature.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SetCallerId.htm">SetCallerId</a></td><td><div class="summary">
|
||
Sets the caller id on the current channel.<br />
|
||
The raw caller id to set, for example "John Doe<1234>".
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SetContext.htm">SetContext</a></td><td><div class="summary">
|
||
Sets the context for continuation upon exiting the application.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SetExtension.htm">SetExtension</a></td><td><div class="summary">
|
||
Sets the extension for continuation upon exiting the application.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SetPriority.htm">SetPriority(Int32)</a></td><td><div class="summary">
|
||
Sets the priority for continuation upon exiting the application.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SetPriority_1.htm">SetPriority(String)</a></td><td><div class="summary">
|
||
Sets the label for continuation upon exiting the application.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_SetVariable.htm">SetVariable</a></td><td><div class="summary">
|
||
Sets the value of the given channel variable to a new value.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_StopMusicOnHold.htm">StopMusicOnHold</a></td><td><div class="summary">
|
||
Stops playing music on hold.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_StreamFile.htm">StreamFile(String)</a></td><td><div class="summary">
|
||
Plays the given file.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_StreamFile_1.htm">StreamFile(String, String)</a></td><td><div class="summary">
|
||
Plays the given file and allows the user to escape by pressing one of the given digit.
|
||
</div></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/7bxwbwt2" target="_blank">ToString</a></td><td><div class="summary">Returns a string that represents the current object.</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_FastAGI_AGIScript_Verbose.htm">Verbose</a></td><td><div class="summary">
|
||
Sends a message to the Asterisk console via the verbose message system.
|
||
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_AGIScript_WaitForDigit.htm">WaitForDigit</a></td><td><div class="summary">
|
||
Waits up to 'timeout' milliseconds to receive a DTMF digit.
|
||
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID1RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_AsterNET_FastAGI_AGIScript.htm">AGIScript Class</a></div><div class="seeAlsoStyle"><a href="N_AsterNET_FastAGI.htm">AsterNET.FastAGI Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html> |