Browse code

uac: docs for rpc command uac.reg_unregister

Daniel-Constantin Mierla authored on 18/11/2020 08:58:00
Showing 1 changed files
... ...
@@ -1276,6 +1276,28 @@ event_route[uac:reply] {
1276 1276
 		</example>
1277 1277
 		</section>
1278 1278
 
1279
+		<section id="uac.r.uac.reg_unregister">
1280
+			<title>
1281
+				<function moreinfo="none">uac.reg_unregister</function>
1282
+			</title>
1283
+		<para>
1284
+			Send REGISTER with expires 0 for matching record, disabling it.
1285
+			The command has two parameter: attribute and value.
1286
+			The attribute can be: l_uuid, l_username, r_username or auth_username.
1287
+			The value is what should be matched against the value of the attribute
1288
+			in the remote registration record.
1289
+		</para>
1290
+		<example>
1291
+		<title><function>uac.reg_unregister</function> usage</title>
1292
+			<programlisting format="linespecific">
1293
+...
1294
+   kamcmd uac.reg_unregister l_uuid account123
1295
+   kamcmd uac.reg_unregister l_uuid s:12345678
1296
+...
1297
+			</programlisting>
1298
+		</example>
1299
+		</section>
1300
+
1279 1301
 		<section id="uac.r.uac.reg_reload">
1280 1302
 			<title>
1281 1303
 				<function moreinfo="none">uac.reg_reload</function>