Add first draft of Connection interface API

diff --git a/doc/Makefile.am b/doc/Makefile.am
index ea75e7f..752c5cc 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -51,4 +51,4 @@ EXTRA_DIST += dbus-introspection.dtd dbus-introspection.xsl \
                                                dbus-manager.xml
 
 EXTRA_DIST += manager-api.txt device-api.txt network-api.txt \
-                                       agent-api.txt plugin-api.txt
+                       connection-api.txt agent-api.txt plugin-api.txt

diff --git a/doc/connection-api.txt b/doc/connection-api.txt
new file mode 100644 (file)
index 0000000..9b6040d
--- /dev/null
+++ b/doc/connection-api.txt
@@ -0,0 +1,30 @@
+Connection hierarchy
+====================
+
+Service                org.moblin.connman
+Interface      org.moblin.connman.Connection
+Object path    [variable prefix]/{connection0,connection1,...}
+
+Methods                dict GetProperties()
+
+                       Returns properties for the connection object. See
+                       the properties section for available properties.
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.DoesNotExist
+
+Signals                PropertyChanged(string name, variant value)
+
+                       This signal indicates a changed value of the given
+                       property.
+
+Properties     string IPv4.Method [readonly]
+
+                       Indicates the way how the IPv4 settings were
+                       configured. Possible values here are "dhcp"
+                       and "static".
+
+               string IPv4.Address [readonly]
+
+                       Shows the current configured IPv4 address.
+                       
\ No newline at end of file