Click or drag to resize
UserEvent Class
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.
To add your own user events you must subclass this class and name it corresponding to your event.
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".
To pass additional data create appropriate attributes with getter and setter methods in your new class.
Example:
            public class VIPCallEvent : UserEvent
            {
            	 private string firstName;
            	 // Constructor
            	 public VIPCallEvent()
            	 {
            	 }
            	 // Property
            	 public string FirstName
            	 {
            		 get { return this.firstName; }
            		 set { this.firstName = value; }
            	 }
             }
            
To send this event use UserEvent(VIPCall|firstName: Jon) in your dialplan.
The UserEvent is implemented in apps/app_userevent.c.
Note that you must register your UserEvent with the ManagerConnection you are using in order to be recognized.
Inheritance Hierarchy

Namespace: AsterNET.Manager.Event
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class UserEvent : ManagerEvent

The UserEvent type exposes the following members.

Constructors
  NameDescription
Public methodUserEvent
Initializes a new instance of the UserEvent class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodParse (Overrides ManagerEventParse(String, String).)
Public methodParseSpecial
Unknown properties parser
(Inherited from ManagerEvent.)
Public methodToString (Inherited from ManagerEvent.)
Top
Fields
  NameDescription
Protected fieldattributes (Inherited from ManagerEvent.)
Top
Properties
  NameDescription
Public propertyAttributes
Store all unknown (without setter) keys from manager event.
Use in default Parse method [!:Parse(string key, string value)].
(Inherited from ManagerEvent.)
Public propertyChannel
Get/Set the name of the channel.
(Inherited from ManagerEvent.)
Public propertyDateReceived
Get/Set the point in time this event was received from the Asterisk server.
Pseudo events that are not directly received from the asterisk server (for example ConnectEvent and DisconnectEvent) may return null.
(Inherited from ManagerEvent.)
Public propertyPrivilege
Get/Set the AMI authorization class of this event.
This is one or more of system, call, log, verbose, command, agent or user. Multiple privileges are separated by comma.
Note: This property is not available from Asterisk 1.0 servers.
(Inherited from ManagerEvent.)
Public propertyServer
Specify a server to which to send your commands (x.x.x.x or hostname).
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.
(Inherited from ManagerEvent.)
Public propertySource
Event source.
(Inherited from ManagerEvent.)
Public propertyTimestamp
Returns the timestamp for this event.
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.
(Inherited from ManagerEvent.)
Public propertyUniqueId
Get/Set the unique id of the channel.
(Inherited from ManagerEvent.)
Public propertyUserEventName
Top
See Also

Reference

[!:Manager.ManagerConnection.RegisterUserEventClass(Type userEventClass)]