diff options
author | Mark Michelson <mmichelson@digium.com> | 2015-06-16 11:13:20 -0500 |
---|---|---|
committer | Richard Mudgett <rmudgett@digium.com> | 2015-06-16 11:22:11 -0500 |
commit | 59552c2d0848fab1207e5b5e815c4b31eb010aef (patch) | |
tree | b01c88e897b6f67bc00ea512e42836be86dcfd34 /res | |
parent | bbeb753e5ed21f6a21242a24092b0d71d9d6c75c (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')
-rw-r--r-- | res/parking/parking_manager.c | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/res/parking/parking_manager.c b/res/parking/parking_manager.c index 175ae5f8b..a560151ab 100644 --- a/res/parking/parking_manager.c +++ b/res/parking/parking_manager.c @@ -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 */ |