---
doc/group-api.txt | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++
doc/manager-api.txt | 6 ++++
2 files changed, 89 insertions(+)
create mode 100644 doc/group-api.txt
diff --git a/doc/group-api.txt b/doc/group-api.txt
new file mode 100644
index 0000000..36a7c24
--- /dev/null
+++ b/doc/group-api.txt
@@ -0,0 +1,83 @@
+Group hierarchy
+=================
+
+Service net.connman
+Interface net.connman.Group
+Object path [variable prefix]/{group0,group1,...}
+
+Methods dict GetProperties()
+
+ Returns all global system properties. See the
+ properties section for available properties.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ void SetProperty(string name, variant value)
+
+ Changes the value of the specified property. Only
+ properties that are listed as read-write are
+ changeable. On success a PropertyChanged signal
+ will be emitted.
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.InvalidProperty
+
+ void Invite(object path)
+
+ Invite another peer to join this group.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ array{object,dict} GetPeers()
+
+ Returns a list of tuples with service object
+ path and dictionary of service properties.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+Signals PeerAdded(object path, dict properties)
+
+ Signal that is sent when a new peer is added.
+
+ It contains the object path of the peer and
+ also its properties.
+
+ PeerRemoved(object path)
+
+ Signal that is sent when a peer has been disconnected
+ from this group.
+
+ It contains the object path of the peer.
+
+ PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+Properties string Name [readonly]
+
+ Network name (SSID) of the group.
+
+ string Passphrase [readwrite]
+
+ The passphrase clients need to join the group. This will
+ be only valid when the device is the owner of the group.
+
+ Clients connecting to a group will need the passphrase
to
+ be allowed to join the group.
+
+ boolean IsOwner [readonly]
+
+ Indicates wether the device is the owner of this group
or
+ not.
+
+ object path Owner [readonly]
+
+ Object path to the service object which is the owner of
+ this group.
+
+ Is only present when IsOwner is false.
+
+ boolean Persistent [readonly]
+
+ Indicates wether this group is persistent or not.group
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index ed23c8d..64e302a 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -145,6 +145,12 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
+ object path CreateGroup()
+
+ Create a new group.
+
+ Possible Errors: [service].Error.InvalidArguments
+
Signals TechnologyAdded(object path, dict properties)
Signal that is sent when a new technology is added.
--
1.8.1.2
_______________________________________________
connman mailing list
connman@connman.net
https://lists.connman.net/mailman/listinfo/connman
