Update of /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/event
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10908/src/java/net/sf/asterisk/manager/event
Modified Files:
UserEvent.java
Log Message:
Clarified javadoc about naming of UserEvents and the need to register them
Index: UserEvent.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/event/UserEvent.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -p -r1.1 -r1.2
--- UserEvent.java 5 Mar 2005 02:27:58 -0000 1.1
+++ UserEvent.java 15 Mar 2005 16:29:02 -0000 1.2
@@ -23,8 +23,10 @@ package net.sf.asterisk.manager.event;
* specifying an event body.<br>
* 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 <code>UserEvent(VIPCall)</code> you will create a new class
- * called VIPCallEvent that extends UserEvent. To pass additional data create appropriate attributes
- * with getter and setter methods in your new class.<br>
+ * 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 extends UserEvent
@@ -48,7 +50,11 @@ package net.sf.asterisk.manager.event;
* }
* </pre>
* To send this event use <code>UserEvent(VIPCall|firstName: Jon)</code> in your dialplan.<br>
- * The UserEvent is implemented in <code>apps/app_userevent.c</code>.
+ * The UserEvent is implemented in <code>apps/app_userevent.c</code>.<br>
+ * Note that you must register your UserEvent with the ManagerConnection you are using in order
+ * to be recognized.
+ *
+ * @see net.sf.asterisk.manager.ManagerConnection#registerUserEventClass(Class)
*
* @author srt
* @version $Id$
|
