[asterisk-commits] mmichelson: branch mmichelson/transfer_stasis r391593 - /team/mmichelson/tran...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Wed Jun 12 22:37:50 2013
New Revision: 391593

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391593
Log:
Add manager event documentation for the BlindTransfer event.


Modified:
    team/mmichelson/transfer_stasis/main/stasis_bridging.c

Modified: team/mmichelson/transfer_stasis/main/stasis_bridging.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/transfer_stasis/main/stasis_bridging.c?view=diff&rev=391593&r1=391592&r2=391593
==============================================================================
--- team/mmichelson/transfer_stasis/main/stasis_bridging.c (original)
+++ team/mmichelson/transfer_stasis/main/stasis_bridging.c Wed Jun 12 22:37:50 2013
@@ -40,6 +40,47 @@
 #include "asterisk/bridging_technology.h"
 
 #define SNAPSHOT_CHANNELS_BUCKETS 13
+
+/*** DOCUMENTATION
+	<managerEvent language="en_US" name="BlindTransfer">
+		<managerEventInstance class="EVENT_FLAG_CALL">
+			<synopsis>Raised when a blind transfer is complete.</synopsis>
+			<syntax>
+				<parameter name="Result">
+					<para>Indicates if the transfer was successful or if it failed.</para>
+					<enumlist>
+						<enum name="Fail"><para>An internal error occurred.</para></enum>
+						<enum name="Invalid"><para>Invalid configuration for transfer (e.g. Not bridged)</para></enum>
+						<enum name="Not Permitted"><para>Bridge does not permit transfers</para></enum>
+						<enum name="Success"><para>Transfer completed successfully</para></enum>
+					</enumlist>
+					<note><para>A result of <literal>Success</literal> does not necessarily mean that a target was succesfully
+					contacted. It means that a party was succesfully placed into the dialplan at the expected location.</para></note>
+				</parameter>
+				<parameter name="Transferer">
+					<para>The name of the channel that performed the transfer</para>
+				</parameter>
+				<parameter name="Bridge">
+					<para>The ID of the bridge where the Transferer performed the transfer</para>
+				</parameter>
+				<parameter name="IsExternal">
+					<para>Indicates if the transfer was performed outside of Asterisk. For instance,
+					a channel protocol native transfer is external. A DTMF transfer is internal.</para>
+						<enumlist>
+							<enum name="Yes" />
+							<enum name="No" />
+						</enumlist>
+				</parameter>
+				<parameter name="Context">
+					<para>Destination context for the blind transfer.</para>
+				</parameter>
+				<parameter name="Extension">
+					<para>Destination extension for the blind transfer.</para>
+				</parameter>
+			</syntax>
+		</managerEventInstance>
+	</managerEvent>
+ ***/
 
 static struct ast_manager_event_blob *attended_transfer_to_ami(struct stasis_message *message);
 static struct ast_manager_event_blob *blind_transfer_to_ami(struct stasis_message *message);