summaryrefslogtreecommitdiff
path: root/res/parking
diff options
context:
space:
mode:
authorMark Michelson <mmichelson@digium.com>2015-06-16 11:13:20 -0500
committerRichard Mudgett <rmudgett@digium.com>2015-06-16 11:21:51 -0500
commit723a9d4225d78391e91d9554b5df65424eed5969 (patch)
treee64d356521e318da4a97e95b9b761c9d1603cb06 /res/parking
parentfd21dc34c2aeccd64b5fcb4d5011d5a34616a5bf (diff)
Parking: Add documentation for AMI ParkedCallSwap event.
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
Diffstat (limited to 'res/parking')
-rw-r--r--res/parking/parking_manager.c16
1 files changed, 16 insertions, 0 deletions
diff --git a/res/parking/parking_manager.c b/res/parking/parking_manager.c
index b9e46c7d5..435200b1e 100644
--- a/res/parking/parking_manager.c
+++ b/res/parking/parking_manager.c
@@ -156,6 +156,22 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</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 */