documentation: Adds versioning information.
Adds version information for applications, functions, and manager events/actions. This is not completely exhaustive by any means but covers most new things added that have release versioning information in the issue tracker. ASTERISK-29940 #close Change-Id: I506401e93c799715dbbe97c0a8ba18af2bf5e131
This commit is contained in:
parent
bce722e60d
commit
0c70d497bc
|
@ -131,6 +131,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</application>
|
</application>
|
||||||
<application name="ConfKick" language="en_US">
|
<application name="ConfKick" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.19.0</version>
|
||||||
|
<version>18.5.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Kicks channel(s) from the requested ConfBridge.
|
Kicks channel(s) from the requested ConfBridge.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -41,6 +41,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<application name="StoreDTMF" language="en_US">
|
<application name="StoreDTMF" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.20.0</version>
|
||||||
|
<version>18.6.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Stores DTMF digits transmitted or received on a channel.
|
Stores DTMF digits transmitted or received on a channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -42,6 +42,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<application name="ReceiveMF" language="en_US">
|
<application name="ReceiveMF" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Detects MF digits on a channel and saves them to a variable.
|
Detects MF digits on a channel and saves them to a variable.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -113,6 +118,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</application>
|
</application>
|
||||||
<application name="SendMF" language="en_US">
|
<application name="SendMF" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Sends arbitrary MF digits on the current or specified channel.
|
Sends arbitrary MF digits on the current or specified channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -151,6 +161,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</application>
|
</application>
|
||||||
<manager name="PlayMF" language="en_US">
|
<manager name="PlayMF" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Play MF digit on a specific channel.
|
Play MF digit on a specific channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -145,6 +145,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</application>
|
</application>
|
||||||
<application name="ReceiveText" language="en_US">
|
<application name="ReceiveText" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.24.0</version>
|
||||||
|
<version>18.10.0</version>
|
||||||
|
<version>19.2.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Receive a Text Message on a channel.
|
Receive a Text Message on a channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -42,6 +42,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<application name="ReceiveSF" language="en_US">
|
<application name="ReceiveSF" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.24.0</version>
|
||||||
|
<version>18.10.0</version>
|
||||||
|
<version>19.2.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Detects SF digits on a channel and saves them to a variable.
|
Detects SF digits on a channel and saves them to a variable.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -107,6 +112,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</application>
|
</application>
|
||||||
<application name="SendSF" language="en_US">
|
<application name="SendSF" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.24.0</version>
|
||||||
|
<version>18.10.0</version>
|
||||||
|
<version>19.2.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Sends arbitrary SF digits on the current or specified channel.
|
Sends arbitrary SF digits on the current or specified channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -39,6 +39,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<application name="WaitForCondition" language="en_US">
|
<application name="WaitForCondition" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.20.0</version>
|
||||||
|
<version>18.6.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Wait (sleep) until the given condition is true.
|
Wait (sleep) until the given condition is true.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -69,6 +69,12 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</function>
|
</function>
|
||||||
<function name="PJSIP_DTMF_MODE" language="en_US">
|
<function name="PJSIP_DTMF_MODE" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>13.18.0</version>
|
||||||
|
<version>14.7.0</version>
|
||||||
|
<version>15.1.0</version>
|
||||||
|
<version>16.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Get or change the DTMF mode for a SIP call.
|
Get or change the DTMF mode for a SIP call.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -94,6 +100,11 @@
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="PJSIP_SEND_SESSION_REFRESH" language="en_US">
|
<function name="PJSIP_SEND_SESSION_REFRESH" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>13.12.0</version>
|
||||||
|
<version>14.1.0</version>
|
||||||
|
<version>15.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
W/O: Initiate a session refresh via an UPDATE or re-INVITE on an established media session
|
W/O: Initiate a session refresh via an UPDATE or re-INVITE on an established media session
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -135,6 +146,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</function>
|
</function>
|
||||||
<function name="PJSIP_PARSE_URI" language="en_US">
|
<function name="PJSIP_PARSE_URI" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>13.24.0</version>
|
||||||
|
<version>16.1.0</version>
|
||||||
|
<version>17.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Parse an uri and return a type part of the URI.
|
Parse an uri and return a type part of the URI.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -64,6 +64,11 @@
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="CHANNEL_EXISTS" language="en_US">
|
<function name="CHANNEL_EXISTS" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.22.0</version>
|
||||||
|
<version>18.8.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Checks if the specified channel exists.
|
Checks if the specified channel exists.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -291,6 +291,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</function>
|
</function>
|
||||||
<function name="BASENAME" language="en_US">
|
<function name="BASENAME" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Return the name of a file.
|
Return the name of a file.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -309,6 +314,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</function>
|
</function>
|
||||||
<function name="DIRNAME" language="en_US">
|
<function name="DIRNAME" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Return the directory of a file.
|
Return the directory of a file.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -38,6 +38,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<function name="FRAME_DROP" language="en_US">
|
<function name="FRAME_DROP" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Drops specific frame types in the TX or RX direction on a channel.
|
Drops specific frame types in the TX or RX direction on a channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -39,6 +39,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<function name="JSON_DECODE" language="en_US">
|
<function name="JSON_DECODE" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.24.0</version>
|
||||||
|
<version>18.10.0</version>
|
||||||
|
<version>19.2.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Returns the string value of a JSON object key from a string containing a
|
Returns the string value of a JSON object key from a string containing a
|
||||||
JSON array.
|
JSON array.
|
||||||
|
|
|
@ -109,6 +109,11 @@
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="MIN" language="en_US">
|
<function name="MIN" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.19.0</version>
|
||||||
|
<version>18.5.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Returns the minimum of two numbers.
|
Returns the minimum of two numbers.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -123,6 +128,11 @@
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="MAX" language="en_US">
|
<function name="MAX" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.19.0</version>
|
||||||
|
<version>18.5.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Returns the maximum of two numbers.
|
Returns the maximum of two numbers.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -137,6 +147,11 @@
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="ABS" language="en_US">
|
<function name="ABS" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.19.0</version>
|
||||||
|
<version>18.5.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Returns absolute value of a number.
|
Returns absolute value of a number.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -42,6 +42,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<function name="SAYFILES" language="en_US">
|
<function name="SAYFILES" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Returns the ampersand-delimited file names that would be played by the Say applications (e.g. SayAlpha, SayDigits).
|
Returns the ampersand-delimited file names that would be played by the Say applications (e.g. SayAlpha, SayDigits).
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -32,6 +32,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<function name="SCRAMBLE" language="en_US">
|
<function name="SCRAMBLE" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Scrambles audio on a channel.
|
Scrambles audio on a channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -155,6 +155,11 @@ AST_THREADSTORAGE(tmp_buf);
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="STRBETWEEN" language="en_US">
|
<function name="STRBETWEEN" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Inserts a substring between each character in a string.
|
Inserts a substring between each character in a string.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -42,6 +42,9 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<function name="TALK_DETECT" language="en_US">
|
<function name="TALK_DETECT" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>12.4.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Raises notifications when Asterisk detects silence or talking on a channel.
|
Raises notifications when Asterisk detects silence or talking on a channel.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -633,6 +633,12 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</manager>
|
</manager>
|
||||||
<manager name="CancelAtxfer" language="en_US">
|
<manager name="CancelAtxfer" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>13.18.0</version>
|
||||||
|
<version>14.7.0</version>
|
||||||
|
<version>15.1.0</version>
|
||||||
|
<version>16.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Cancel an attended transfer.
|
Cancel an attended transfer.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -146,6 +146,11 @@
|
||||||
</description>
|
</description>
|
||||||
</function>
|
</function>
|
||||||
<function name="PJSIP_HEADERS" language="en_US">
|
<function name="PJSIP_HEADERS" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.20.0</version>
|
||||||
|
<version>18.6.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Gets the list of SIP header names from an INVITE message.
|
Gets the list of SIP header names from an INVITE message.
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
|
@ -46,6 +46,11 @@
|
||||||
|
|
||||||
/*** DOCUMENTATION
|
/*** DOCUMENTATION
|
||||||
<application name="WaitForTone" language="en_US">
|
<application name="WaitForTone" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Wait for tone
|
Wait for tone
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -94,6 +99,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</application>
|
</application>
|
||||||
<application name="ToneScan" language="en_US">
|
<application name="ToneScan" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.23.0</version>
|
||||||
|
<version>18.9.0</version>
|
||||||
|
<version>19.1.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Wait for period of time while scanning for call progress tones
|
Wait for period of time while scanning for call progress tones
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
@ -169,6 +179,11 @@
|
||||||
</see-also>
|
</see-also>
|
||||||
</application>
|
</application>
|
||||||
<function name="TONE_DETECT" language="en_US">
|
<function name="TONE_DETECT" language="en_US">
|
||||||
|
<since>
|
||||||
|
<version>16.21.0</version>
|
||||||
|
<version>18.7.0</version>
|
||||||
|
<version>19.0.0</version>
|
||||||
|
</since>
|
||||||
<synopsis>
|
<synopsis>
|
||||||
Asynchronously detects a tone
|
Asynchronously detects a tone
|
||||||
</synopsis>
|
</synopsis>
|
||||||
|
|
Loading…
Reference in New Issue