diff options
| author | Rusty Newton <rnewton@digium.com> | 2016-05-27 12:25:55 -0500 |
|---|---|---|
| committer | Richard Mudgett <rmudgett@digium.com> | 2016-05-27 12:43:54 -0500 |
| commit | b56f61185641d06e10105b6e5444e3fcccbe6616 (patch) | |
| tree | cfdab37fbaeb8c89092ac695bc85d5a31f08b244 /res/res_pjsip_header_funcs.c | |
| parent | de298889047deee01afb451ceedaf7b463616fae (diff) | |
res_pjsip: Add clarifying documentation to PJSIP_HEADER help text
Added notes about when you can read or write headers. Specifically
about being able to read on the inbound channel and write on an
outbound channel.
ASTERISK-26063 #close
Reported by: Private Name
Tested by: Rusty Newton
Change-Id: Ibeb64af17d1f6451028b3c29855a3f151a01d8c5
Diffstat (limited to 'res/res_pjsip_header_funcs.c')
| -rw-r--r-- | res/res_pjsip_header_funcs.c | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/res/res_pjsip_header_funcs.c b/res/res_pjsip_header_funcs.c index 7d164b12a..648f1c860 100644 --- a/res/res_pjsip_header_funcs.c +++ b/res/res_pjsip_header_funcs.c @@ -39,7 +39,8 @@ /*** DOCUMENTATION <function name="PJSIP_HEADER" language="en_US"> <synopsis> - Gets, adds, updates or removes the specified SIP header from a PJSIP session. + Gets headers from an inbound PJSIP channel. Adds, updates or removes the + specified SIP header from an outbound PJSIP channel. </synopsis> <syntax> <parameter name="action" required="true"> @@ -75,6 +76,10 @@ </syntax> <description> + <para>PJSIP_HEADER allows you to read specific SIP headers from the inbound + PJSIP channel as well as write(add, update, remove) headers on the outbound + channel. One exception is that you can read headers that you have already + added on the outbound channel.</para> <para>Examples:</para> <para>;</para> <para>; Set 'somevar' to the value of the 'From' header.</para> @@ -120,7 +125,7 @@ <note><para>If you call PJSIP_HEADER in a normal dialplan context you'll be operating on the <emphasis>caller's (incoming)</emphasis> channel which - may not be what you want. To operate on the <emphasis>callee's (outgoing)</emphasis> + may not be what you want. To operate on the <emphasis>callee's (outgoing)</emphasis> channel call PJSIP_HEADER in a pre-dial handler. </para> <para>Example:</para> <para>;</para> |