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

func_callerid: Document that CALLERID(pres) is available.

Browse Source 
CALLERPRES() says that it's deprecated in favor of CALLERID(num-pres)
and CALLERID(name-pres).  But for channel driver that don't make a
distinction between the two (e.g. SIP), it makes more sense to get/set
both at once.  This change reveals the availability of CALLERID(pres),
CONNECTEDLINE(pres), REDIRECTING(orig-pres), REDIRECTING(to-pres) and
REDIRECTING(from-pres).

ASTERISK-25373 #close

Change-Id: I5614ae4ab7d3bbe9c791c1adf147e10de8698d7a
This commit is contained in:
Walter Doekes
2015-11-06 14:54:59 +01:00
parent f12ebe3584
commit 7dd8f89a50
2 changed files with 33 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
funcs/func_callerid.c
View File

@@ -40,10 +40,11 @@ ASTERISK_REGISTER_FILE()
#include "asterisk/callerid.h"
/*
* Do not document the CALLERID(pres) datatype.
* The name and number now have their own presentation value. The pres
* option will simply live on as a historical relic with as best
* as can be managed backward compatible meaning.
* The CALLERID(pres) datatype is shorthand for getting/setting the
* combined value of name-pres and num-pres. Some channel drivers
* don't make a distinction, so it makes sense to only use one property
* to get/set it. The same applies to CONNECTEDLINE(pres),
* REDIRECTING(orig-pres), REDIRECTING(from-pres) and REDIRECTING(to-pres).
*
* Do not document the CALLERID(ton) datatype.
* It is an alias for num-plan.
@@ -55,11 +56,6 @@ ASTERISK_REGISTER_FILE()
* It has turned out to not be needed. The source value is really
* only useful as a possible tracing aid.
*
* Do not document the CONNECTEDLINE(pres) datatype.
* The name and number now have their own presentation value. The pres
* option will simply live on as a historical relic with as best
* as can be managed backward compatible meaning.
*
* Do not document the CONNECTEDLINE(ton) datatype.
* It is an alias for num-plan.
*
@@ -69,12 +65,6 @@ ASTERISK_REGISTER_FILE()
* they are active at the same time. The plain pres option will simply
* live on as a historical relic.
*
* Do not document the REDIRECTING(orig-pres), REDIRECTING(from-pres),
* or REDIRECTING(to-pres) datatypes.
* The name and number now have their own presentation value. The orig-pres,
* from-pres, and to-pres options will simply live on as a historical relic
* with as best as can be managed backward compatible meaning.
*
* Do not document the REDIRECTING(orig-ton), REDIRECTING(from-ton),
* or REDIRECTING(to-ton) datatypes.
* They are aliases for orig-num-plan, from-num-plan, and to-num-plan
@@ -98,6 +88,7 @@ ASTERISK_REGISTER_FILE()
<enum name = "num-valid" />
<enum name = "num-plan" />
<enum name = "num-pres" />
<enum name = "pres" />
<enum name = "subaddr" />
<enum name = "subaddr-valid" />
<enum name = "subaddr-type" />
@@ -144,6 +135,9 @@ ASTERISK_REGISTER_FILE()
<description>
<para>Gets or sets Caller*ID data on the channel. Uses channel callerid by
default or optional callerid, if specified.</para>
<para>The <replaceable>pres</replaceable> field gets/sets a combined value
for <replaceable>name-pres</replaceable> and
<replaceable>num-pres</replaceable>.</para>
<para>The allowable values for the <replaceable>name-charset</replaceable>
field are the following:</para>
<enumlist>
@@ -168,7 +162,8 @@ ASTERISK_REGISTER_FILE()
<description>
<para>Gets or sets Caller*ID presentation on the channel.
This function is deprecated in favor of CALLERID(num-pres)
and CALLERID(name-pres).
and CALLERID(name-pres) or CALLERID(pres) to get/set both
at once.
The following values are valid:</para>
<enumlist>
<enum name="allowed_not_screened">
@@ -218,6 +213,7 @@ ASTERISK_REGISTER_FILE()
<enum name = "num-valid" />
<enum name = "num-plan" />
<enum name = "num-pres" />
<enum name = "pres" />
<enum name = "subaddr" />
<enum name = "subaddr-valid" />
<enum name = "subaddr-type" />
@@ -246,6 +242,9 @@ ASTERISK_REGISTER_FILE()
</syntax>
<description>
<para>Gets or sets Connected Line data on the channel.</para>
<para>The <replaceable>pres</replaceable> field gets/sets a combined value
for <replaceable>name-pres</replaceable> and
<replaceable>num-pres</replaceable>.</para>
<para>The allowable values for the <replaceable>name-charset</replaceable>
field are the following:</para>
<enumlist>
@@ -279,6 +278,7 @@ ASTERISK_REGISTER_FILE()
<enum name = "orig-num-valid" />
<enum name = "orig-num-plan" />
<enum name = "orig-num-pres" />
<enum name = "orig-pres" />
<enum name = "orig-subaddr" />
<enum name = "orig-subaddr-valid" />
<enum name = "orig-subaddr-type" />
@@ -294,6 +294,7 @@ ASTERISK_REGISTER_FILE()
<enum name = "from-num-valid" />
<enum name = "from-num-plan" />
<enum name = "from-num-pres" />
<enum name = "from-pres" />
<enum name = "from-subaddr" />
<enum name = "from-subaddr-valid" />
<enum name = "from-subaddr-type" />
@@ -308,6 +309,7 @@ ASTERISK_REGISTER_FILE()
<enum name = "to-num-valid" />
<enum name = "to-num-plan" />
<enum name = "to-num-pres" />
<enum name = "to-pres" />
<enum name = "to-subaddr" />
<enum name = "to-subaddr-valid" />
<enum name = "to-subaddr-type" />
@@ -366,6 +368,11 @@ ASTERISK_REGISTER_FILE()
</syntax>
<description>
<para>Gets or sets Redirecting data on the channel.</para>
<para>The <replaceable>orig-pres</replaceable>,
<replaceable>from-pres</replaceable> and <replaceable>to-pres</replaceable>
fields get/set a combined value for the corresponding
<replaceable>...-name-pres</replaceable> and <replaceable>...-num-pres</replaceable>
fields.</para>
<para>The allowable values for the <replaceable>reason</replaceable>
and <replaceable>orig-reason</replaceable> fields are the following:</para>
<enumlist>