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

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Thu Jun 13 13:10:42 2013
New Revision: 391674

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391674
Log:
Add some more details about attended transfers to manager event documentation.


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=391674&r1=391673&r2=391674
==============================================================================
--- team/mmichelson/transfer_stasis/main/stasis_bridging.c (original)
+++ team/mmichelson/transfer_stasis/main/stasis_bridging.c Thu Jun 13 13:10:42 2013
@@ -89,13 +89,13 @@
 					<para>The original transferer channel that performed the attended transfer.</para>
 				</parameter>
 				<parameter name="Bridge1">
-					<para>The bridge that Transferer1 was in, or <literal>None</literal> if Transferer1 was not bridged</para>
+					<para>The unique ID of the bridge that <replaceable>Transferer1</replaceable> was in, or <literal>None</literal> if Transferer1 was not bridged</para>
 				</parameter>
 				<parameter name="Transferer2">
 					<para>The second transferer channel involved in the attended transfer.</para>
 				</parameter>
 				<parameter name="Bridge2">
-					<para>The bridge that Transferer2 was in, or <literal>None</literal> if Transferer2 was not bridged</para>
+					<para>The unique ID of the bridge that <replaceable>Transferer2</replaceable> was in, or <literal>None</literal> if Transferer2 was not bridged</para>
 				</parameter>
 				<parameter name="DestType">
 					<para>Indicates the method by which the attended transfer completed.</para>
@@ -123,6 +123,20 @@
 					<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
 				</parameter>
 			</syntax>
+			<description>
+				<para>The headers in this event attempt to describe all the major details of the attended transfer. The two transferer channels
+				and the two bridges are determined based on their chronological establishment. So consider that Alice calls Bob, and then Alice
+				transfers the call to Voicemail. The transferer and bridge headers would be arranged as follows:</para>
+				<para>	<replaceable>Transferer1</replaceable>: Alice's channel in the bridge with Bob.</para>
+				<para>	<replaceable>Bridge1</replaceable>: The bridge between Alice and Bob.</para>
+				<para>	<replaceable>Transferer2</replaceable>: Alice's channel that called Voicemail.</para>
+				<para>	<replaceable>Bridge2</replaceable>: None, since a call to Voicemail has no bridge.</para>
+				<para>Now consider if the order were reversed; instead of having Alice call Bob and transfer him to Voicemail, Alice instead
+				calls her Voicemail and transfers that to Bob. The transferer and bridge headers would be arranged as follows:</para>
+				<para>	<replaceable>Transferer1</replaceable>: Alice's channel that called Voicemail.</para>
+				<para>	<replaceable>Bridge1</replaceable>: None, since a call to Voicemail has no bridge.</para>
+				<para>	<replaceable>Transferer2</replaceable>: Alice's channel in the bridge with Bob.</para>
+				<para>	<replaceable>Bridge2</replaceable>: The bridge between Alice and Bob.</para>
 		</managerEventInstance>
 	</managerEvent>
  ***/