[asterisk-commits] mmichelson: trunk r94903 - /trunk/doc/manager_1_1.txt

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Thu Dec 27 11:18:39 2007
New Revision: 94903

URL: http://svn.digium.com/view/asterisk?view=rev&rev=94903
Log:
Adding documentation for new manager actions and events in app_queue


Modified:
    trunk/doc/manager_1_1.txt

Modified: trunk/doc/manager_1_1.txt
URL: http://svn.digium.com/view/asterisk/trunk/doc/manager_1_1.txt?view=diff&rev=94903&r1=94902&r2=94903
==============================================================================
--- trunk/doc/manager_1_1.txt (original)
+++ trunk/doc/manager_1_1.txt Thu Dec 27 11:18:39 2007
@@ -141,6 +141,35 @@
 		Asterisk) and module not found.
 		Also, check if other manager actions behave that way.
 
+- Action: QueueSummary
+	Modules: app_queue
+	Purpose:
+		To request that the manager send a QueueSummary event (see the NEW EVENTS
+	    section for more details).
+	Variables:
+	  ActionID: <id>		Action ID for this transaction. Will be returned.
+	  Queue: <name>			Queue for which the summary is desired
+
+- Action: QueuePenalty
+	Modules: app_queue
+	Purpose:
+		To change the penalty of a queue member from AMI
+	Variables:
+	  Interface: <tech/name>	The interface of the member whose penalty you wish to change
+	  Penalty:  <number>		The new penalty for the member. Must be nonnegative.
+	  Queue:  <name>			If specified, only set the penalty for the member for this queue;
+	  								Otherwise, set the penalty for the member in all queues to which
+									he belongs.
+
+- Action: QueueRule
+	Modules: app_queue
+	Purpose:
+		To list queue rules defined in queuerules.conf
+	Variables:
+	  Rule: <name>			The name of the rule whose contents you wish to list. If this variable
+	  							is not present, all rules in queuerules.conf will be listed.
+		
+
 * NEW EVENTS
 ------------
 
@@ -233,6 +262,20 @@
 		ModuleLoadStatus: Done
 		ModuleSelection: All
 		ModuleCount: 24
+
+- Event: QueueSummary
+	Modules: app_queue
+	Purpose: To report a summary of queue information. This event is generated by
+		issuing a QueueSummary AMI action.
+	Example:
+		Event: QueueSummary
+		Queue: Sales
+		LoggedIn: 12
+		Available: 5
+		Callers: 10
+		HoldTime: 47
+	If an actionID was specified for the QueueSummary action, it will be appended as the
+	last line of the QueueSummary event.
 		
 
 * TODO