doc: Add AgentManager API documentation

2016-11-07 11:50:20 -06:00 · 2016-11-07 11:50:20 -06:00 · 0b98f75dda
parent e9e9358898
commit 0b98f75dda
1 changed files with 22 additions and 0 deletions
--- a/doc/agent-manager-api.txt
+++ b/doc/agent-manager-api.txt
@ -0,0 +1,22 @@
+Agent hierarchy
+===============
+
+Service		net.connman.iwd
+Interface	net.connman.iwd.AgentManager
+Object path	/
+
+Methods		void RegisterAgent(object path)
+
+			Register new agent for handling user requests.
+
+			Possible Errors: [service].Error.InvalidArguments
+					 [service].Error.Failed
+					 [service].Error.AlreadyExists
+
+		void UnregisterAgent(object path)
+
+			Unregister an existing agent.
+
+			Possible Errors: [service].Error.InvalidArguments
+					 [service].Error.Failed
+					 [service].Error.NotFound