Update QueueMemberStatus event documentation to include member status values
authorMatthew Jordan <mjordan@digium.com>
Thu, 6 Sep 2012 22:21:12 +0000 (22:21 +0000)
committerMatthew Jordan <mjordan@digium.com>
Thu, 6 Sep 2012 22:21:12 +0000 (22:21 +0000)
The Status: header in a QueueMemberStatus event (and other QueueMember* events)
is the numeric value of the device state corresponding to that Queue Member.
As those values are not exactly obvious, listing them in the documentation is
useful.

Matt Riddell reported this indirectly through the wiki page.

(closes issue ASTERISK-20243)
Reported by: Matt Riddell
........

Merged revisions 372531 from http://svn.asterisk.org/svn/asterisk/branches/11

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@372538 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_queue.c

index 2309d05..06e5fc8 100644 (file)
@@ -1612,7 +1612,18 @@ static int update_status(struct call_queue *q, struct member *m, const int statu
                                <para>The time this member last took call, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
                        </parameter>
                        <parameter name="Status">
-                               <para>The status of the queue member.  This will be a device state value.</para>
+                               <para>The numeric device state status of the queue member.</para>
+                               <enumlist>
+                                       <enum name="0"><para>AST_DEVICE_UNKNOWN</para></enum>
+                                       <enum name="1"><para>AST_DEVICE_NOT_INUSE</para></enum>
+                                       <enum name="2"><para>AST_DEVICE_INUSE</para></enum>
+                                       <enum name="3"><para>AST_DEVICE_BUSY</para></enum>
+                                       <enum name="4"><para>AST_DEVICE_INVALID</para></enum>
+                                       <enum name="5"><para>AST_DEVICE_UNAVAILABLE</para></enum>
+                                       <enum name="6"><para>AST_DEVICE_RINGING</para></enum>
+                                       <enum name="7"><para>AST_DEVICE_RINGINUSE</para></enum>
+                                       <enum name="8"><para>AST_DEVICE_ONHOLD</para></enum>
+                               </enumlist>
                        </parameter>
                        <parameter name="Paused">
                                <enumlist>