55 lines
13 KiB
HTML
55 lines
13 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>RegistryEvent Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="RegistryEvent class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.Event.RegistryEvent" /><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_RegistryEvent" /><meta name="guid" content="Properties_T_AsterNET_Manager_Event_RegistryEvent" /><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_RegistryEvent.htm" title="RegistryEvent Class" tocid="T_AsterNET_Manager_Event_RegistryEvent">RegistryEvent 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_RegistryEvent.htm" title="RegistryEvent Properties" tocid="Properties_T_AsterNET_Manager_Event_RegistryEvent">RegistryEvent Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_RegistryEvent_Cause.htm" title="Cause Property " tocid="P_AsterNET_Manager_Event_RegistryEvent_Cause">Cause Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_RegistryEvent_ChannelType.htm" title="ChannelType Property " tocid="P_AsterNET_Manager_Event_RegistryEvent_ChannelType">ChannelType Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_RegistryEvent_Domain.htm" title="Domain Property " tocid="P_AsterNET_Manager_Event_RegistryEvent_Domain">Domain Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_RegistryEvent_Status.htm" title="Status Property " tocid="P_AsterNET_Manager_Event_RegistryEvent_Status">Status Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_Event_RegistryEvent_User.htm" title="User Property " tocid="P_AsterNET_Manager_Event_Re
|
|||
|
|
|
|||
|
|
</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_ManagerEvent_Attributes.htm">Attributes</a></td><td><div class="summary">
|
|||
|
|
Store all unknown (without setter) keys from manager event.<br />
|
|||
|
|
Use in default Parse method <span class="nolink">[!:Parse(string key, string value)]</span>.
|
|||
|
|
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_RegistryEvent_Cause.htm">Cause</a></td><td><div class="summary">
|
|||
|
|
Get/Set the cause of a rejected registration.
|
|||
|
|
The cause of a rejected registration or "<unknown>" if the cause is unknown.
|
|||
|
|
</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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_RegistryEvent_ChannelType.htm">ChannelType</a></td><td><div class="summary">
|
|||
|
|
Channel type
|
|||
|
|
"SIP",
|
|||
|
|
"IAX2"
|
|||
|
|
</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_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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_Event_RegistryEvent_Domain.htm">Domain</a></td><td><div class="summary">
|
|||
|
|
Get/Set the domain or host name of the SIP or IAX2 server.<br />
|
|||
|
|
This is the host part used in the register lines in
|
|||
|
|
iax.conf and sip.conf.
|
|||
|
|
</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_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">
|
|||
|
|
Event source.
|
|||
|
|
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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_RegistryEvent_Status.htm">Status</a></td><td><div class="summary">
|
|||
|
|
Get/Set the registration state.<br />
|
|||
|
|
For sip this may be one of (not sure if all of these are exposed via the
|
|||
|
|
manager api, at least "Registered" and "Timeout" are used though)
|
|||
|
|
<ul><li>Registered</li><li>Unregistered</li><li>Request Sent</li><li>Auth. Sent</li><li>Rejected</li><li>Timeout</li><li>No Authentication</li><li>Unreachable</li></ul>
|
|||
|
|
IAX2 only uses
|
|||
|
|
<ul><li>Rejected</li></ul>
|
|||
|
|
Successful IAX2 registrations do not use the this property at all.
|
|||
|
|
</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_Timestamp.htm">Timestamp</a></td><td><div class="summary">
|
|||
|
|
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><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_RegistryEvent_User.htm">User</a></td><td><div class="summary">
|
|||
|
|
Sets the username used for registration.
|
|||
|
|
</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_RegistryEvent_Username.htm">Username</a></td><td><div class="summary">
|
|||
|
|
Get/Set the username used for registration.<br />
|
|||
|
|
SIP send the username in case of a registration timeout, IAX2 in case of
|
|||
|
|
a registration failure. Otherwise the username is null.
|
|||
|
|
</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_Manager_Event_RegistryEvent.htm">RegistryEvent 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>
|