[sr-dev] git:master:b1535317: textops: docs for replace_body_str(...)

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: b15353177f9acb8a52941f073c360753f0138145
URL: https://github.com/kamailio/kamailio/commit/b15353177f9acb8a52941f073c360753f0138145

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-07-12T16:27:24+02:00

textops: docs for replace_body_str(...)

---

Modified: src/modules/textops/doc/textops_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/b15353177f9acb8a52941f073c360753f0138145.diff
Patch: https://github.com/kamailio/kamailio/commit/b15353177f9acb8a52941f073c360753f0138145.patch

---

diff --git a/src/modules/textops/doc/textops_admin.xml b/src/modules/textops/doc/textops_admin.xml
index 3e62d7ac44..7d7f2d62ce 100644
--- a/src/modules/textops/doc/textops_admin.xml
+++ b/src/modules/textops/doc/textops_admin.xml
@@ -439,6 +439,43 @@ replace_str("&kamailio;", "&kamailio; SIP Proxy", "a");
 		</example>
 	</section>
 
+	<section id="textops.f.replace_body_str">
+		<title>
+		<function moreinfo="none">replace_body_str(match, repl, mode)</function>
+		</title>
+		<para>
+		Replaces the first or all occurrence of 'match' with 'repl' by doing
+		string comparison for matching. It is applied over the message body.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para><emphasis>match</emphasis> - string to be matched.
+			</para>
+		</listitem>
+		<listitem>
+			<para><emphasis>repl</emphasis> - string to be used as replacement.
+			</para>
+		</listitem>
+		<listitem>
+			<para><emphasis>mode</emphasis> - 'f' - replace only first match;
+				'a' - replace all matches.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>replace_body_str</function> usage</title>
+		<programlisting format="linespecific">
+...
+replace_body_str("&kamailio;", "&kamailio; SIP Proxy", "a");
+...
+</programlisting>
+		</example>
+	</section>
+
 	<section id="textops.f.subst">
 		<title>
 		<function moreinfo="none">subst('/re/repl/flags')</function>