Parking: Add documentation for AMI ParkedCallSwap event.
authorMark Michelson <mmichelson@digium.com>
Tue, 16 Jun 2015 16:13:20 +0000 (11:13 -0500)
committerRichard Mudgett <rmudgett@digium.com>
Tue, 16 Jun 2015 16:22:11 +0000 (11:22 -0500)
This event was added some time ago in order to clarify when a channel
took the place of another channel in a parking lot. However, there was
no XML documentation added for the event. This patch adds the XML
documentation.

ASTERISK-24900 #close
Reported by Rusty Newton

Change-Id: I4cfe7777c4b94bbff91c9221c6096a7a02a92eac

res/parking/parking_manager.c

index 175ae5f..a560151 100644 (file)
@@ -156,6 +156,22 @@ ASTERISK_REGISTER_FILE()
                        </syntax>
                </managerEventInstance>
        </managerEvent>
+       <managerEvent language="en_US" name="ParkedCallSwap">
+               <managerEventInstance class="EVENT_FLAG_CALL">
+                       <synopsis>Raised when a channel takes the place of a previously parked channel</synopsis>
+                       <syntax>
+                               <channel_snapshot prefix="Parkee"/>
+                               <channel_snapshot prefix="Parker"/>
+                               <xi:include xpointer="xpointer(/docs/managerEvent[@name='ParkedCall']/managerEventInstance/syntax/parameter)" />
+                       </syntax>
+                       <description>
+                               <para>This event is raised when a channel initially parked in the parking lot
+                               is swapped out with a different channel. The most common case for this is when
+                               an attended transfer to a parking lot occurs. The Parkee information in the event
+                               will indicate the party that was swapped into the parking lot.</para>
+                       </description>
+               </managerEventInstance>
+       </managerEvent>
  ***/
 
 /*! \brief subscription to the parking lot topic */