From 7d94bdde9d48b385a41c794a7260fd3773cf6ca5 Mon Sep 17 00:00:00 2001
From: Sean Bright <sean.bright@gmail.com>
Date: Fri, 3 Jan 2020 11:20:29 -0500
Subject: [PATCH] res_agi: Improve GET FULL VARIABLE documentation
ASTERISK-28673 #close
Reported by: Jonathan Harris
Change-Id: I591afdec669622bfa19243aabec31b579652c92f
---
res/res_agi.c | 20 +++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
diff --git a/res/res_agi.c b/res/res_agi.c
index 0e2c76faff..77ba226e27 100644
--- a/res/res_agi.c
+++ b/res/res_agi.c
@@ -323,15 +323,21 @@
Evaluates a channel expression
</synopsis>
<syntax>
- <parameter name="variablename" required="true" />
- <parameter name="channel name" />
+ <parameter name="expression" required="true" />
+ <parameter name="channelname" />
</syntax>
<description>
- <para>Returns <literal>0</literal> if <replaceable>variablename</replaceable> is not set
- or channel does not exist. Returns <literal>1</literal> if <replaceable>variablename</replaceable>
- is set and returns the variable in parenthesis. Understands complex variable names and builtin
- variables, unlike GET VARIABLE.</para>
- <para>Example return code: 200 result=1 (testvariable)</para>
+ <para>Evaluates the given <replaceable>expression</replaceable> against the
+ channel specified by <replaceable>channelname</replaceable>, or the current
+ channel if <replaceable>channelname</replaceable> is not provided.</para>
+ <para>Unlike GET VARIABLE, the <replaceable>expression</replaceable> is
+ processed in a manner similar to dialplan evaluation, allowing complex
+ and built-in variables to be accessed, e.g. <literal>The time is
+ ${EPOCH}</literal></para>
+ <para>Returns <literal>0</literal> if no channel matching
+ <replaceable>channelname</replaceable> exists, <literal>1</literal>
+ otherwise.</para>
+ <para>Example return code: 200 result=1 (The time is 1578493800)</para>
</description>
<see-also>
<ref type="agi">get variable</ref>
--
GitLab