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

47 lines
14 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>HangupEvent Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="HangupEvent class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Event.HangupEvent" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Event" /><meta name="file" content="Properties_T_AsterNET_Manager_Event_HangupEvent" /><meta name="guid" content="Properties_T_AsterNET_Manager_Event_HangupEvent" /><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_Event.htm" title="AsterNET.Manager.Event" tocid="N_AsterNET_Manager_Event">AsterNET.Manager.Event</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Event_HangupEvent.htm" title="HangupEvent Class" tocid="T_AsterNET_Manager_Event_HangupEvent">HangupEvent 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="Properties_T_AsterNET_Manager_Event_HangupEvent.htm" title="HangupEvent Properties" tocid="Properties_T_AsterNET_Manager_Event_HangupEvent">HangupEvent Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_HangupEvent_Cause.htm" title="Cause Property " tocid="P_AsterNET_Manager_Event_HangupEvent_Cause">Cause Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_HangupEvent_CauseTxt.htm" title="CauseTxt Property " tocid="P_AsterNET_Manager_Event_HangupEvent_CauseTxt">CauseTxt Property </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">HangupEvent Properties</td></tr></table><span class="introStyle"></span><p>The <a href="T_AsterNET_Manager_Even
 
</th><th>Name</th><th>Description</th></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_Event_AbstractChannelEvent_AccountCode.htm">AccountCode</a></td><td><div class="summary">
Get/Set channel AccountCode
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_ManagerEvent_Attributes.htm">Attributes</a></td><td><div class="summary">
Store all unknown (without setter) keys from manager event.<br />
update documentation
2016-10-05 06:38:17 +00:00
Use in default Parse method <a href="M_AsterNET_Manager_Event_ManagerEvent_Parse.htm">Parse(String, String)</a></div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_Event_AbstractChannelEvent_CallerId.htm">CallerId</a></td><td><div class="summary">
add sandcastle generated documentation for github pages
2016-10-03 09:15:07 +00:00
Get/Set the Caller*ID of the channel if set or &lt;unknown&gt; if none has been set.
Adding documentation Source Tree was giving trouble so commiting through Github app
2016-10-28 07:07:55 +00:00
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_AbstractChannelEvent_CallerIdName.htm">CallerIdName</a></td><td><div class="summary">
Get/Set the Caller*ID Name of the channel if set or &lt;unknown&gt; if none has been set.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_AbstractChannelEvent_CallerIdNum.htm">CallerIdNum</a></td><td><div class="summary">
add sandcastle generated documentation for github pages
2016-10-03 09:15:07 +00:00
Get/Set the Caller*ID of the channel if set or &lt;unknown&gt; if none has been set.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_HangupEvent_Cause.htm">Cause</a></td><td><div class="summary">
Get/Set the cause of the hangup.
</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_Event_HangupEvent_CauseTxt.htm">CauseTxt</a></td><td><div class="summary">
Get/Set the textual representation of the hangup cause.
</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_Event_ManagerEvent_Channel.htm">Channel</a></td><td><div class="summary">
Get/Set the name of the channel.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_Event_AbstractChannelEvent_ChannelState.htm">ChannelState</a></td><td><div class="summary">
Get/Set Channel State
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_AbstractChannelEvent_ChannelStateDesc.htm">ChannelStateDesc</a></td><td><div class="summary">
Get/Set Channel State Description
</div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_AbstractChannelEvent_ConnectedLineName.htm">ConnectedLineName</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_AbstractChannelEvent_Connectedlinenum.htm">Connectedlinenum</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_ManagerEvent_DateReceived.htm">DateReceived</a></td><td><div class="summary">
Get/Set the point in time this event was received from the Asterisk server.<br />
Pseudo events that are not directly received from the asterisk server
(for example ConnectEvent and DisconnectEvent) may return null.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_Event_ManagerEvent_Privilege.htm">Privilege</a></td><td><div class="summary">
Get/Set the AMI authorization class of this event.<br />
This is one or more of system, call, log, verbose, command, agent or user.
Multiple privileges are separated by comma.<br />
Note: This property is not available from Asterisk 1.0 servers.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_Event_ManagerEvent_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_Event_ManagerEvent.htm">ManagerEvent</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_Event_ManagerEvent_Source.htm">Source</a></td><td><div class="summary">
update documentation
2016-10-05 06:38:17 +00:00
The ManagerConnection the Event was sourced from.
Adding documentation Source Tree was giving trouble so commiting through Github app
2016-10-28 07:07:55 +00:00
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_Event_AbstractChannelEvent_State.htm">State</a></td><td><div class="summary">
Get/Set the (new) state of the channel.<br />
The following states are used:<br /><ul><li>Down</li><li>OffHook</li><li>Dialing</li><li>Ring</li><li>Ringing</li><li>Up</li><li>Busy</li></ul></div> (Inherited from <a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</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_Event_ManagerEvent_Timestamp.htm">Timestamp</a></td><td><div class="summary">
add sandcastle generated documentation for github pages
2016-10-03 09:15:07 +00:00
Returns the timestamp for this event.<br />
The timestamp property is available in Asterisk since 1.4
if enabled in manager.conf by setting timestampevents = yes.
In contains the time the event was generated in seconds since the epoch.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_Event_ManagerEvent_UniqueId.htm">UniqueId</a></td><td><div class="summary">
Get/Set the unique id of the channel.
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</a>.)</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_Manager_Event_HangupEvent.htm">HangupEvent Class</a></div><div class="seeAlsoStyle"><a href="N_AsterNET_Manager_Event.htm">AsterNET.Manager.Event Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
Reference in a new issue Copy permalink