From 7dd8f89a507f1eeab6bfaaf6c29db40ad1228c49 Mon Sep 17 00:00:00 2001 From: Walter Doekes Date: Fri, 6 Nov 2015 14:54:59 +0100 Subject: func_callerid: Document that CALLERID(pres) is available. 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 --- funcs/func_callerid.c | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) (limited to 'funcs') diff --git a/funcs/func_callerid.c b/funcs/func_callerid.c index 159934949..dee1977f4 100644 --- a/funcs/func_callerid.c +++ b/funcs/func_callerid.c @@ -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() + @@ -144,6 +135,9 @@ ASTERISK_REGISTER_FILE() Gets or sets Caller*ID data on the channel. Uses channel callerid by default or optional callerid, if specified. + The pres field gets/sets a combined value + for name-pres and + num-pres. The allowable values for the name-charset field are the following: @@ -168,7 +162,8 @@ ASTERISK_REGISTER_FILE() 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: @@ -218,6 +213,7 @@ ASTERISK_REGISTER_FILE() + @@ -246,6 +242,9 @@ ASTERISK_REGISTER_FILE() Gets or sets Connected Line data on the channel. + The pres field gets/sets a combined value + for name-pres and + num-pres. The allowable values for the name-charset field are the following: @@ -279,6 +278,7 @@ ASTERISK_REGISTER_FILE() + @@ -294,6 +294,7 @@ ASTERISK_REGISTER_FILE() + @@ -308,6 +309,7 @@ ASTERISK_REGISTER_FILE() + @@ -366,6 +368,11 @@ ASTERISK_REGISTER_FILE() Gets or sets Redirecting data on the channel. + The orig-pres, + from-pres and to-pres + fields get/set a combined value for the corresponding + ...-name-pres and ...-num-pres + fields. The allowable values for the reason and orig-reason fields are the following: -- cgit v1.2.3