kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 19:28:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

manager: Add <since> tags for all AMI actions.

Browse Source 
(cherry picked from commit 7d97560656)
This commit is contained in:
Sean Bright
2025-01-02 14:38:30 -05:00
committed by Asterisk Development Team
parent b2b2fde59e
commit 82c1fb71e6
37 changed files with 507 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
main/bridge.c
View File

@@ -29,6 +29,9 @@
/*** DOCUMENTATION
<manager name="BridgeTechnologyList" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
List available bridging technologies and their statuses.
</synopsis>
@@ -44,6 +47,9 @@
</see-also>
</manager>
<manager name="BridgeTechnologySuspend" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
Suspend a bridging technology.
</synopsis>
@@ -62,6 +68,9 @@
</see-also>
</manager>
<manager name="BridgeTechnologyUnsuspend" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
Unsuspend a bridging technology.
</synopsis>

3
main/core_local.c
View File

@@ -53,6 +53,9 @@
/*** DOCUMENTATION
<manager name="LocalOptimizeAway" language="en_US">
<since>
<version>1.8.0</version>
</since>
<synopsis>
Optimize away a local channel when possible.
</synopsis>

17
main/db.c
View File

@@ -54,6 +54,9 @@
/*** DOCUMENTATION
<manager name="DBGet" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis>
Get DB Entry.
</synopsis>
@@ -66,6 +69,11 @@
</description>
</manager>
<manager name="DBGetTree" language="en_US">
<since>
<version>19.6.0</version>
<version>18.14.0</version>
<version>16.28.0</version>
</since>
<synopsis>
Get DB entries, optionally at a particular family/key
</synopsis>
@@ -78,6 +86,9 @@
</description>
</manager>
<manager name="DBPut" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis>
Put DB entry.
</synopsis>
@@ -91,6 +102,9 @@
</description>
</manager>
<manager name="DBDel" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Delete DB entry.
</synopsis>
@@ -103,6 +117,9 @@
</description>
</manager>
<manager name="DBDelTree" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Delete DB Tree.
</synopsis>

3
main/features.c
View File

@@ -216,6 +216,9 @@
</see-also>
</application>
<manager name="Bridge" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Bridge two channels already in the PBX.
</synopsis>

12
main/manager_bridges.c
View File

@@ -107,6 +107,9 @@ static struct stasis_message_router *bridge_state_router;
</managerEventInstance>
</managerEvent>
<manager name="BridgeList" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
Get a list of bridges in the system.
</synopsis>
@@ -127,6 +130,9 @@ static struct stasis_message_router *bridge_state_router;
</see-also>
</manager>
<manager name="BridgeInfo" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
Get information about a bridge.
</synopsis>
@@ -167,6 +173,9 @@ static struct stasis_message_router *bridge_state_router;
</responses>
</manager>
<manager name="BridgeDestroy" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
Destroy a bridge.
</synopsis>
@@ -188,6 +197,9 @@ static struct stasis_message_router *bridge_state_router;
</see-also>
</manager>
<manager name="BridgeKick" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
Kick a channel from a bridge.
</synopsis>

120
main/manager_doc.xml
View File

@@ -3,6 +3,9 @@
<?xml-stylesheet type="text/xsl" href="appdocsxml.xslt"?>
<docs xmlns:xi="http://www.w3.org/2001/XInclude">
<manager name="Ping" language="en_US">
<since>
<version>0.2.0</version>
</since>
<synopsis>
Keepalive command.
</synopsis>
@@ -15,6 +18,9 @@
</description>
</manager>
<manager name="Events" language="en_US">
<since>
<version>0.9.0</version>
</since>
<synopsis>
Control Event Flow.
</synopsis>
@@ -39,6 +45,9 @@
</description>
</manager>
<manager name="Logoff" language="en_US">
<since>
<version>0.2.0</version>
</since>
<synopsis>
Logoff Manager.
</synopsis>
@@ -53,6 +62,9 @@
</see-also>
</manager>
<manager name="Login" language="en_US">
<since>
<version>0.2.0</version>
</since>
<synopsis>
Login Manager.
</synopsis>
@@ -102,6 +114,9 @@
</see-also>
</manager>
<manager name="Challenge" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis>
Generate Challenge for MD5 Auth.
</synopsis>
@@ -119,6 +134,9 @@
</description>
</manager>
<manager name="Hangup" language="en_US">
<since>
<version>0.2.0</version>
</since>
<synopsis>
Hangup channel.
</synopsis>
@@ -138,6 +156,9 @@
</description>
</manager>
<manager name="Status" language="en_US">
<since>
<version>0.2.0</version>
</since>
<synopsis>
List channel status.
</synopsis>
@@ -241,6 +262,9 @@
</managerEventInstance>
</managerEvent>
<manager name="Setvar" language="en_US">
<since>
<version>1.0.0</version>
</since>
<synopsis>
Sets a channel variable or function value.
</synopsis>
@@ -268,6 +292,9 @@
</see-also>
</manager>
<manager name="Getvar" language="en_US">
<since>
<version>1.0.0</version>
</since>
<synopsis>
Gets a channel variable or function value.
</synopsis>
@@ -291,6 +318,9 @@
</see-also>
</manager>
<manager name="GetConfig" language="en_US">
<since>
<version>1.4.0</version>
</since>
<synopsis>
Retrieve configuration.
</synopsis>
@@ -329,6 +359,9 @@
</see-also>
</manager>
<manager name="GetConfigJSON" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Retrieve configuration (JSON format).
</synopsis>
@@ -359,6 +392,9 @@
</see-also>
</manager>
<manager name="UpdateConfig" language="en_US">
<since>
<version>1.4.0</version>
</since>
<synopsis>
Update basic configuration.
</synopsis>
@@ -456,6 +492,9 @@
</see-also>
</manager>
<manager name="CreateConfig" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Creates an empty file in the configuration directory.
</synopsis>
@@ -478,6 +517,9 @@
</see-also>
</manager>
<manager name="ListCategories" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
List categories in configuration file.
</synopsis>
@@ -498,6 +540,9 @@
</see-also>
</manager>
<manager name="Redirect" language="en_US">
<since>
<version>0.2.0</version>
</since>
<synopsis>
Redirect (transfer) a call.
</synopsis>
@@ -536,6 +581,9 @@
</see-also>
</manager>
<manager name="Atxfer" language="en_US">
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Attended transfer.
</synopsis>
@@ -560,10 +608,9 @@
</manager>
<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>
<version>14.7.0</version>
<version>13.18.0</version>
</since>
<synopsis>
Cancel an attended transfer.
@@ -584,6 +631,9 @@
</see-also>
</manager>
<manager name="Originate" language="en_US">
<since>
<version>0.2.0</version>
</since>
<synopsis>
Originate a call.
</synopsis>
@@ -674,6 +724,9 @@
</managerEventInstance>
</managerEvent>
<manager name="Command" language="en_US">
<since>
<version>0.3.0</version>
</since>
<synopsis>
Execute Asterisk CLI Command.
</synopsis>
@@ -688,6 +741,9 @@
</description>
</manager>
<manager name="ExtensionState" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis>
Check Extension Status.
</synopsis>
@@ -711,6 +767,9 @@
</see-also>
</manager>
<manager name="PresenceState" language="en_US">
<since>
<version>11.0.0</version>
</since>
<synopsis>
Check Presence State
</synopsis>
@@ -730,6 +789,9 @@
</see-also>
</manager>
<manager name="AbsoluteTimeout" language="en_US">
<since>
<version>0.5.0</version>
</since>
<synopsis>
Set absolute timeout.
</synopsis>
@@ -748,6 +810,9 @@
</description>
</manager>
<manager name="MailboxStatus" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis>
Check mailbox.
</synopsis>
@@ -770,6 +835,9 @@
</see-also>
</manager>
<manager name="MailboxCount" language="en_US">
<since>
<version>0.5.0</version>
</since>
<synopsis>
Check Mailbox Message Count.
</synopsis>
@@ -793,6 +861,9 @@
</see-also>
</manager>
<manager name="ListCommands" language="en_US">
<since>
<version>1.0.0</version>
</since>
<synopsis>
List available manager commands.
</synopsis>
@@ -805,6 +876,9 @@
</description>
</manager>
<manager name="SendText" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Sends a text message to channel. A content type can be optionally specified. If not set
it is set to an empty string allowing a custom handler to default it as it sees fit.
@@ -829,6 +903,9 @@
</see-also>
</manager>
<manager name="UserEvent" language="en_US">
<since>
<version>1.4.0</version>
</since>
<synopsis>
Send an arbitrary event.
</synopsis>
@@ -853,6 +930,9 @@
</see-also>
</manager>
<manager name="WaitEvent" language="en_US">
<since>
<version>1.4.0</version>
</since>
<synopsis>
Wait for an event to occur.
</synopsis>
@@ -869,6 +949,9 @@
</description>
</manager>
<manager name="CoreSettings" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Show PBX core settings (version etc).
</synopsis>
@@ -880,6 +963,9 @@
</description>
</manager>
<manager name="CoreStatus" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Show PBX core status variables.
</synopsis>
@@ -891,6 +977,9 @@
</description>
</manager>
<manager name="Reload" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Send a reload event.
</synopsis>
@@ -951,6 +1040,9 @@
</managerEventInstance>
</managerEvent>
<manager name="CoreShowChannels" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
List currently active channels.
</synopsis>
@@ -981,6 +1073,10 @@
</managerEventInstance>
</managerEvent>
<manager name="CoreShowChannelMap" language="en_US">
<since>
<version>20.4.0</version>
<version>18.19.0</version>
</since>
<synopsis>
List all channels connected to the specified channel.
</synopsis>
@@ -995,6 +1091,9 @@
</description>
</manager>
<manager name="LoggerRotate" language="en_US">
<since>
<version>13.0.0</version>
</since>
<synopsis>
Reload and rotate the Asterisk logger.
</synopsis>
@@ -1006,6 +1105,9 @@
</description>
</manager>
<manager name="ModuleLoad" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Module management.
</synopsis>
@@ -1051,6 +1153,9 @@
</see-also>
</manager>
<manager name="ModuleCheck" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Check if module is loaded.
</synopsis>
@@ -1070,6 +1175,9 @@
</see-also>
</manager>
<manager name="AOCMessage" language="en_US">
<since>
<version>1.8.0</version>
</since>
<synopsis>
Generate an Advice of Charge message on a channel.
</synopsis>
@@ -1297,6 +1405,9 @@
</description>
</function>
<manager name="Filter" language="en_US">
<since>
<version>10.0.0</version>
</since>
<synopsis>
Dynamically add filters for the current manager session.
</synopsis>
@@ -1334,6 +1445,9 @@
</description>
</manager>
<manager name="BlindTransfer" language="en_US">
<since>
<version>12.0.0</version>
</since>
<synopsis>
Blind transfer channel(s) to the given destination
</synopsis>

3
main/message.c
View File

@@ -185,6 +185,9 @@
</description>
</application>
<manager name="MessageSend" language="en_US">
<since>
<version>11.0.0</version>
</since>
<synopsis>
Send an out of call message to an endpoint.
</synopsis>

6
main/pbx.c
View File

@@ -152,6 +152,9 @@
</see-also>
</function>
<manager name="ShowDialPlan" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis>
Show dialplan contexts and extensions
</synopsis>
@@ -170,6 +173,9 @@
</description>
</manager>
<manager name="ExtensionStateList" language="en_US">
<since>
<version>13.0.0</version>
</since>
<synopsis>
List the current known extension states.
</synopsis>