[asterisk-commits] lmadsen: trunk r149040 - /trunk/doc/manager_1_1.txt

[SVN commits to the Asterisk project]

Author: lmadsen
Date: Tue Oct 14 14:35:54 2008
New Revision: 149040

URL: http://svn.digium.com/view/asterisk?view=rev&rev=149040
Log:
Add missing documentation for SipShowRegistry action and RegistryEntry event.
(closes issue #13342)
Reported and patch by: Laureano


Modified:
    trunk/doc/manager_1_1.txt

Modified: trunk/doc/manager_1_1.txt
URL: http://svn.digium.com/view/asterisk/trunk/doc/manager_1_1.txt?view=diff&rev=149040&r1=149039&r2=149040
==============================================================================
--- trunk/doc/manager_1_1.txt (original)
+++ trunk/doc/manager_1_1.txt Tue Oct 14 14:35:54 2008
@@ -187,6 +187,12 @@
 		Priority: The priority to transfer to
 		Context: The context to transfer to
 
+- Action: SipShowRegistry
+	Modules: chan_sip
+	Purpose:
+		To request that the manager send a list of RegistryEntry events.
+	Variables:
+	  ActionId: <id>		Action ID for this transaction. Will be returned.
 
 * NEW EVENTS
 ------------
@@ -307,6 +313,22 @@
 		MemberName: Thaddeus McClintock
 		Ringtime: 10
 
+- Event: RegistryEntry
+	Modules: chan_sip
+	Purpose: Reports the state of the SIP registrations. This event is generated by
+                issuing a QueueSummary AMI action.
+		The RegistrationTime header is expressed as epoch.
+	Example:
+		Event: RegistryEntry
+		Host: sip.myvoipprovider.com
+		Port: 5060
+		Username: guestuser
+		Refresh: 105
+		State: Registered
+		RegistrationTime: 1219161830
+	If an actionID was specified for the SipShowRegistry action, it will be appended as the
+	last line of the RegistrationsComplete event.
+
 * TODO
 ------