72 lines
22 KiB
HTML
72 lines
22 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>UserEvent Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="UserEvent class" /><meta name="System.Keywords" content="AsterNET.Manager.Event.UserEvent class" /><meta name="System.Keywords" content="UserEvent class, about UserEvent class" /><meta name="Microsoft.Help.F1" content="AsterNET.Manager.Event.UserEvent" /><meta name="Microsoft.Help.Id" content="T:AsterNET.Manager.Event.UserEvent" /><meta name="Description" content="Abstract base class for user events. You can send arbitrary user events via the UserEvent application provided with asterisk. A user event by default has the attributes channel and uniqueId but you can add custom attributes by specifying an event body." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Event" /><meta name="file" content="T_AsterNET_Manager_Event_UserEvent" /><meta name="guid" content="T_AsterNET_Manager_Event_UserEvent" /><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="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_Event_UserEvent.htm" title="UserEvent Class" tocid="T_AsterNET_Manager_Event_UserEvent">UserEvent Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="M_AsterNET_Manager_Event_UserEvent__ctor.htm" title="UserEvent Constructor " tocid="M_AsterNET_Manager_Event_UserEvent__ctor">UserEvent Constructor </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="Fields_T_AsterNET_Manager_Event_UserEvent.htm" title="UserEvent Fields" tocid="Fields_T_AsterNET_Manager_Event_UserEvent">UserEvent Fields</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_Event_UserEvent.htm" title="UserEvent Methods" tocid="Methods_T_AsterNET_Manager_Event_UserEvent">UserEvent 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_Event_UserEvent.htm" title="UserEvent Properties" tocid="Properties_T_AsterNET_Manager_Event_UserEvent">UserEvent Properties</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">UserEvent Class</td></tr></table><span class="introStyle"></span><div class="summary">
|
||
Abstract base class for user events.<br />
|
||
You can send arbitrary user events via the UserEvent application provided with asterisk.
|
||
A user event by default has the attributes channel and uniqueId but you can add custom
|
||
attributes by specifying an event body.<br />
|
||
To add your own user events you must subclass this class and name it corresponding to your event.<br />
|
||
If you plan to send an event by UserEvent(VIPCall) you will create a new class
|
||
called VIPCallEvent that extends UserEvent. The name of this class is important: Just use the
|
||
name of the event you will send (VIPCall in this example) and append "Event".<br />
|
||
To pass additional data create appropriate attributes with getter and setter methods in your new class.<br />
|
||
Example:
|
||
<pre>
|
||
public class VIPCallEvent : UserEvent
|
||
{
|
||
private string firstName;
|
||
// Constructor
|
||
public VIPCallEvent()
|
||
{
|
||
}
|
||
// Property
|
||
public string FirstName
|
||
{
|
||
get { return this.firstName; }
|
||
set { this.firstName = value; }
|
||
}
|
||
}
|
||
</pre>
|
||
To send this event use UserEvent(VIPCall|firstName: Jon) in your dialplan.<br />
|
||
The UserEvent is implemented in apps/app_userevent.c.<br />
|
||
Note that you must register your UserEvent with the ManagerConnection you are using in order to be recognized.
|
||
</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="LSTC3D0130F_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC3D0130F_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br /> <a href="http://msdn2.microsoft.com/en-us/library/118wxtk3" target="_blank">System<span id="LSTC3D0130F_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC3D0130F_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>EventArgs</a><br /> <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">AsterNET.Manager.Event<span id="LSTC3D0130F_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC3D0130F_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ManagerEvent</a><br /> <span class="selflink">AsterNET.Manager.Event<span id="LSTC3D0130F_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC3D0130F_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>UserEvent</span><br /></div><p> </p><strong>Namespace:</strong> <a href="N_AsterNET_Manager_Event.htm">AsterNET.Manager.Event</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">UserEvent</span> : <span class="identifier">ManagerEvent</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">UserEvent</span>
|
||
<span class="keyword">Inherits</span> <span class="identifier">ManagerEvent</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">UserEvent</span> : <span class="keyword">public</span> <span class="identifier">ManagerEvent</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">UserEvent</span> =
|
||
<span class="keyword">class</span>
|
||
<span class="keyword">inherit</span> <span class="identifier">ManagerEvent</span>
|
||
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">UserEvent</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_Event_UserEvent__ctor.htm">UserEvent</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">UserEvent</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;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="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_Event_UserEvent_Parse.htm">Parse</a></td><td> (Overrides <a href="M_AsterNET_Manager_Event_ManagerEvent_Parse.htm">ManagerEvent<span id="LSTC3D0130F_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC3D0130F_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Parse(String, String)</a>.)</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_Event_ManagerEvent_ParseSpecial.htm">ParseSpecial</a></td><td><div class="summary">
|
||
Unknown properties parser
|
||
</div> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</a>.)</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_Event_ManagerEvent_ToString.htm">ToString</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</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" />Fields</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="protected;inherited;notNetfw;"><td><img src="../icons/protfield.gif" alt="Protected field" title="Protected field" /></td><td><a href="F_AsterNET_Manager_Event_ManagerEvent_attributes.htm">attributes</a></td><td> (Inherited from <a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID6RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
|
||
|
||
</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;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_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">
|
||
Event source.
|
||
</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_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_UserEvent_UserEventName.htm">UserEventName</a></td><td /></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID7RB')" onkeypress="SectionExpandCollapse_CheckKey('ID7RB', event)" tabindex="0"><img id="ID7RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID7RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_AsterNET_Manager_Event.htm">AsterNET.Manager.Event Namespace</a></div><div class="seeAlsoStyle"><span class="nolink">[!:Manager.ManagerConnection.RegisterUserEventClass(Type userEventClass)]</span></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html> |