Added Agent and obexd D-Bus API

1 files changed, 88 insertions, 0 deletions

diff --git a/doc/obexd-api.txt b/doc/obexd-api.txt
new file mode 100644
index 0000000..87bcf7e
--- /dev/null
+++ b/doc/obexd-api.txt
@@ -0,0 +1,88 @@
+obexd API description
+**********************************
+
+Copyright (C) 2007-2008  Nokia Corporation
+Copyright (C) 2007-2008  Instituto Nokia de Tecnologia (INdT)
+Copyright (C) 2007-2008  Marcel Holtmann <marcel@holtmann.org>
+
+
+Manager hierarchy
+===============
+
+Service		org.openobex
+Interface	org.openobex.Manager
+Object path	/
+
+Methods
+		void RegisterAgent(object agent)
+
+			Register an agent to authorize accept connection
+			or objects. Object push service needs to authorize
+			each received object.
+
+			Possible errors: org.openobex.Error.AlreadyExists
+
+		void UnregisterAgent(object agent)
+
+			This unregisters the agent that has been previously
+			registered. The object path parameter must match the
+			same value that has been used on registration.
+
+			Possible errors: org.openobex.Error.DoesNotExist
+
+Signals		SessionCreated(object session)
+			
+			Signal sent when OBEX connection has been accepted.
+			(FTP only)
+
+		SessionRemoved(object session)
+			
+			Sent when the transport is disconnected
+			(FTP only)
+
+		TransferStarted(object transfer)
+
+			Signal sent when the
+			(OPP only)
+
+		TransferCompleted(object transfer, boolean success)
+
+			Signal sent when the object has been received
+			or an error happens.
+			(OPP only)
+
+
+Transfer hierarchy
+===============
+
+Service		org.openobex
+Interface	org.openobex.Transfer
+Object path	/transfer{0, 1, 2, ...}
+
+Methods
+		void Cancel()
+
+			Stops the current transference.
+
+Signals
+		Progress(int32 total, int32 transfered)
+
+
+Session hierarchy
+===============
+
+Service		org.openobex
+Interface	org.openobex.Session
+Object path	/session{0, 1, 2, ...}
+
+Methods
+		dict GetProperties()
+
+
+Signals		TBD
+
+
+Properties
+		string Address [readonly]
+
+			Bluetooth device address or USB