Add org.bluez.Database interface definition

1 files changed, 36 insertions, 46 deletions

diff --git a/hcid/dbus-api.txt b/hcid/dbus-api.txt
index 25e32fef..b7ecda0b 100644
--- a/hcid/dbus-api.txt
+++ b/hcid/dbus-api.txt
@@ -1,7 +1,7 @@
 D-Bus API description for BlueZ
 *******************************
 
-Copyright (C) 2004-2006  Marcel Holtmann <marcel@holtmann.org>
+Copyright (C) 2004-2007  Marcel Holtmann <marcel@holtmann.org>
 Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com>
 Copyright (C) 2005-2006  Claudio Takahasi <claudio.takahasi@indt.org.br>
 Copyright (C) 2005-2006  Eduardo Rocha <eduardo.rocha@indt.org.br>
@@ -173,7 +173,7 @@ Methods		uint32 InterfaceVersion()
 			patterns are well known or unique bus names.
 
 			Possible errors: org.bluez.Error.InvalidArguments
-			                 org.bluez.Error.NoSuchService
+					 org.bluez.Error.NoSuchService
 
 		array{string} ListServices()
 
@@ -187,71 +187,61 @@ Methods		uint32 InterfaceVersion()
 			Valid patterns are the same as for FindService(). If
 			the service is not running it will be started.
 
-		uint32 AddServiceRecord(string path, array{byte}) [experimental]
+Signals		void AdapterAdded(string path)
 
-			Add a new service record to the service agent
-			and returns the assigned handle.
+			Parameter is object path of added adapter.
 
-			The path parameter is the object path of the
-			service agent. The second parameter is the binary
-			representation of a service record. If the service
-			agent is running the service record will be automatically
-			registered, otherwise the record will be available
-			when the service agent Start method is called.
+		void AdapterRemoved(string path)
 
-			Possible errors: org.bluez.Error.InvalidArguments
-					 org.bluez.Error.NotAuthorized
-					 org.bluez.Error.Failed
+			Parameter is object path of removed adapter.
 
-		uint32 AddServiceRecordFromXML(string path, string record) [experimental]
+		void DefaultAdapterChanged(string path)
 
-			Add a new service record to the service agent
-			and returns the assigned handle.
+			Parameter is object path of the new default adapter.
 
-			The path parameter is the object path of the
-			service agent. The record parameter is the XML
-			representation of a service record. If the service
-			agent is running the service record will be automatically
-			registered, otherwise the record will be available
-			when the service agent Start method is called.
+		void ServiceAdded(string path)
 
-			Possible errors: org.bluez.Error.InvalidArguments
-					 org.bluez.Error.NotAuthorized
-					 org.bluez.Error.Failed
+			Parameter is object path of registered service agent.
 
+		void ServiceRemoved(string path)
 
-		void RemoveServiceRecord(string path, uint32 handle) [experimental]
+			Parameter is object path of unregistered service agent.
 
-			Remove a service record from the service agent
-			records list.
 
-			The path parameter is the object path of the service
-			agent. The second parameter is service record handle.
-	
-			Possible errors: org.bluez.Error.InvalidArguments
-					 org.bluez.Error.NotAuthorized
-					 org.bluez.Error.DoesNotExist
-					 org.bluez.Error.Failed
+Database hierarchy
+==================
 
-Signals		void AdapterAdded(string path)
+Service		org.bluez
+Interface	org.bluez.Database
+Object path	/org/bluez or /org/bluez/{hci0,hci1,...}
 
-			Parameter is object path of added adapter.
+		uint32 AddServiceRecord(array{byte})
 
-		void AdapterRemoved(string path)
+			Adds a new service record and returns the assigned
+			record handle.
 
-			Parameter is object path of removed adapter.
+			Possible errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.Failed
 
-		void DefaultAdapterChanged(string path)
+		uint32 AddServiceRecordFromXML(string record)
 
-			Parameter is object path of the new default adapter.
+			Adds a new service record and returns the assigned
+			record handle.
 
-		void ServiceAdded(string path)
+			Possible errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.Failed
 
-			Parameter is object path of registered service agent.
+		void RemoveServiceRecord(uint32 handle)
 
-		void ServiceRemoved(string path)
+			Remove a service record identified by its handle.
 
-			Parameter is object path of unregistered service agent.
+			It is only possible to remove service records that
+			where added by the current connection.
+
+			Possible errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.NotAuthorized
+					 org.bluez.Error.DoesNotExist
+					 org.bluez.Error.Failed
 
 
 Adapter hierarchy