[asterisk-commits] jrose: branch 13 r426120 - /branches/13/main/manager.c

[SVN commits to the Asterisk project]

Author: jrose
Date: Fri Oct 24 10:17:59 2014
New Revision: 426120

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=426120
Log:
Documentation: Improve documentation for ExtensionStatus AMI events

Review: https://reviewboard.asterisk.org/r/4085/

Modified:
    branches/13/main/manager.c

Modified: branches/13/main/manager.c
URL: http://svnview.digium.com/svn/asterisk/branches/13/main/manager.c?view=diff&rev=426120&r1=426119&r2=426120
==============================================================================
--- branches/13/main/manager.c (original)
+++ branches/13/main/manager.c Fri Oct 24 10:17:59 2014
@@ -1191,11 +1191,76 @@
 		<managerEventInstance class="EVENT_FLAG_CALL">
 			<synopsis>Raised when a hint changes due to a device state change.</synopsis>
 			<syntax>
-				<parameter name="Exten" />
-				<parameter name="Context" />
-				<parameter name="Hint" />
-				<parameter name="Status" />
-				<parameter name="StatusText" />
+				<parameter name="Exten">
+					<para>Name of the extension.</para>
+				</parameter>
+				<parameter name="Context">
+					<para>Context that owns the extension.</para>
+				</parameter>
+				<parameter name="Hint">
+					<para>Hint set for the extension</para>
+				</parameter>
+				<parameter name="Status">
+					<para>Numerical value of the extension status. Extension
+					status is determined by the combined device state of all items
+					contained in the hint.</para>
+					<enumlist>
+						<enum name="-2">
+							<para>The extension was removed from the dialplan.</para>
+						</enum>
+						<enum name="-1">
+							<para>The extension's hint was removed from the dialplan.</para>
+						</enum>
+						<enum name="0">
+							<para><literal>Idle</literal> - Related device(s) are in an idle
+							state.</para>
+						</enum>
+						<enum name="1">
+							<para><literal>InUse</literal> - Related device(s) are in active
+							calls but may take more calls.</para>
+						</enum>
+						<enum name="2">
+							<para><literal>Busy</literal> - Related device(s) are in active
+							calls and may not take any more calls.</para>
+						</enum>
+						<enum name="4">
+							<para><literal>Unavailable</literal> - Related device(s) are
+							not reachable.</para>
+						</enum>
+						<enum name="8">
+							<para><literal>Ringing</literal> - Related device(s) are
+							currently ringing.</para>
+						</enum>
+						<enum name="9">
+							<para><literal>InUse&Ringing</literal> - Related device(s)
+							are currently ringing and in active calls.</para>
+						</enum>
+						<enum name="16">
+							<para><literal>Hold</literal> - Related device(s) are
+							currently on hold.</para>
+						</enum>
+						<enum name="17">
+							<para><literal>InUse&Hold</literal> - Related device(s)
+							are currently on hold and in active calls.</para>
+						</enum>
+					</enumlist>
+				</parameter>
+				<parameter name="StatusText">
+					<para>Text representation of <literal>Status</literal>.</para>
+					<enumlist>
+						<enum name="Idle" />
+						<enum name="InUse" />
+						<enum name="Busy" />
+						<enum name="Unavailable" />
+						<enum name="Ringing" />
+						<enum name="InUse&Ringing" />
+						<enum name="Hold" />
+						<enum name="InUse&Hold" />
+						<enum name="Unknown">
+							<para>Status does not match any of the above values.</para>
+						</enum>
+					</enumlist>
+				</parameter>
 			</syntax>
 		</managerEventInstance>
 	</managerEvent>