[asterisk-commits] qwell: branch qwell/queue_events r390337 - /team/qwell/queue_events/apps/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Fri May 31 15:12:33 CDT 2013
Author: qwell
Date: Fri May 31 15:12:31 2013
New Revision: 390337
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=390337
Log:
Fix up docs. Stop referring to agents so much. Even if the events are still Agent events...
Modified:
team/qwell/queue_events/apps/app_queue.c
Modified: team/qwell/queue_events/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/team/qwell/queue_events/apps/app_queue.c?view=diff&rev=390337&r1=390336&r2=390337
==============================================================================
--- team/qwell/queue_events/apps/app_queue.c (original)
+++ team/qwell/queue_events/apps/app_queue.c Fri May 31 15:12:31 2013
@@ -900,11 +900,11 @@
<parameter name="Queue">
<para>The name of the queue.</para>
</parameter>
- <parameter name="Location">
- <para>The queue member's channel technology or location.</para>
- </parameter>
<parameter name="MemberName">
<para>The name of the queue member.</para>
+ </parameter>
+ <parameter name="Interface">
+ <para>The queue member's channel technology or location.</para>
</parameter>
<parameter name="StateInterface">
<para>Channel technology or location from which to read device state changes.</para>
@@ -945,6 +945,12 @@
<enum name="1"/>
</enumlist>
</parameter>
+ <parameter name="Ringinuse">
+ <enumlist>
+ <enum name="0"/>
+ <enum name="1"/>
+ </enumlist>
+ </parameter>
</syntax>
</managerEventInstance>
</managerEvent>
@@ -952,16 +958,7 @@
<managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised when a member is added to the queue.</synopsis>
<syntax>
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='StateInterface'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Membership'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Penalty'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='CallsTaken'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='LastCall'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Status'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Paused'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
</syntax>
<see-also>
<ref type="managerEvent">QueueMemberRemoved</ref>
@@ -973,9 +970,7 @@
<managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised when a member is removed from the queue.</synopsis>
<syntax>
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
</syntax>
<see-also>
<ref type="managerEvent">QueueMemberAdded</ref>
@@ -987,10 +982,10 @@
<managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised when a member is paused/unpaused in the queue.</synopsis>
<syntax>
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Paused'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
+ <parameter name="Reason">
+ <para>The reason a member was paused.</para>
+ </parameter>
</syntax>
<see-also>
<ref type="application">PauseQueueMember</ref>
@@ -1002,9 +997,7 @@
<managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised when a member's penalty is changed.</synopsis>
<syntax>
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Penalty'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
</syntax>
<see-also>
<ref type="function">QUEUE_MEMBER</ref>
@@ -1015,23 +1008,16 @@
<managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
<syntax>
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
- <parameter name="Ringinuse">
- <enumlist>
- <enum name="0"/>
- <enum name="1"/>
- </enumlist>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
</syntax>
<see-also>
<ref type="function">QUEUE_MEMBER</ref>
</see-also>
</managerEventInstance>
</managerEvent>
- <managerEvent language="en_US" name="QueueJoin">
+ <managerEvent language="en_US" name="QueueCallerJoin">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when a channel joins a Queue.</synopsis>
+ <synopsis>Raised when a caller joins a Queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
<parameter name="Position">
@@ -1042,30 +1028,30 @@
</parameter>
</syntax>
<see-also>
- <ref type="managerEvent">QueueLeave</ref>
+ <ref type="managerEvent">QueueCallerLeave</ref>
<ref type="application">Queue</ref>
</see-also>
</managerEventInstance>
</managerEvent>
- <managerEvent language="en_US" name="QueueLeave">
+ <managerEvent language="en_US" name="QueueCallerLeave">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when a channel leaves a Queue.</synopsis>
+ <synopsis>Raised when a caller leaves a Queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueJoin']/managerEventInstance/syntax/parameter[@name='Count'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Count'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
</syntax>
<see-also>
- <ref type="managerEvent">QueueJoin</ref>
+ <ref type="managerEvent">QueueCallerJoin</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="QueueCallerAbandon">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when an caller abandons the queue.</synopsis>
+ <synopsis>Raised when a caller abandons the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerJoin']/managerEventInstance/syntax/parameter[@name='Position'])" />
<parameter name="OriginalPosition">
<para>The channel's original position in the queue.</para>
</parameter>
@@ -1077,15 +1063,11 @@
</managerEvent>
<managerEvent language="en_US" name="AgentCalled">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when an Agent is notified of a member in the queue.</synopsis>
+ <synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <parameter name="AgentCalled">
- <para>The agent's technology or location.</para>
- </parameter>
- <parameter name="AgentName">
- <para>The name of the agent.</para>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
</syntax>
<see-also>
<ref type="managerEvent">AgentRingNoAnswer</ref>
@@ -1096,15 +1078,13 @@
</managerEvent>
<managerEvent language="en_US" name="AgentRingNoAnswer">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when an agent is notified of a member in the queue and fails to answer.</synopsis>
+ <synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
- <parameter name="Member">
- <para>The queue member's channel technology or location.</para>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
<parameter name="RingTime">
- <para>The time the agent was rung, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
+ <para>The time the queue member was rung, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
</parameter>
</syntax>
<see-also>
@@ -1114,14 +1094,14 @@
</managerEvent>
<managerEvent language="en_US" name="AgentComplete">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when an agent has finished servicing a member in the queue.</synopsis>
+ <synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='Member'])" />
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
<parameter name="TalkTime">
- <para>The time the agent talked with the member in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
+ <para>The time the queue member talked with the caller in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
</parameter>
<parameter name="Reason">
<enumlist>
@@ -1139,11 +1119,11 @@
</managerEvent>
<managerEvent language="en_US" name="AgentDump">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when an agent hangs up on a member in the queue.</synopsis>
+ <synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='Member'])" />
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
</syntax>
<see-also>
<ref type="managerEvent">AgentCalled</ref>
@@ -1153,11 +1133,11 @@
</managerEvent>
<managerEvent language="en_US" name="AgentConnect">
<managerEventInstance class="EVENT_FLAG_AGENT">
- <synopsis>Raised when an agent answers and is bridged to a member in the queue.</synopsis>
+ <synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
- <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='Member'])" />
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Interface'])" />
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='RingTime'])" />
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
</syntax>
More information about the asterisk-commits
mailing list