Imported Upstream connman version 1.38
[platform/upstream/connman.git] / doc / manager-api.txt
old mode 100644 (file)
new mode 100755 (executable)
index 1f4663e..6eaa0a3
@@ -39,7 +39,19 @@ Methods              dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
-               object ConnectProvider(dict provider)
+               array{object,dict} GetPeers() [experimental]
+
+                       Returns a sorted list of tuples with peer object path
+                       and dictionary of peer properties
+
+                       Possible Errors: [service].Error.InvalidArguments
+
+               array{string} GetTetheringClients() [experimental]
+
+                       Returns a sorted list of MAC addresses of clients
+                       connected to tethered technologies.
+
+               object ConnectProvider(dict provider)   [deprecated]
 
                        Connect to a VPN specified by the given provider
                        properties.
@@ -58,8 +70,16 @@ Methods              dict GetProperties()
                        When 'SessionMode' property is enabled, this method
                        call is disallowed.
 
+                       This API is deprecated and should not be used.
+                       The VPN configuration API is provided by ConnMan
+                       VPN daemon and user should use that one instead.
+
                        Possible Errors: [service].Error.InvalidArguments
 
+               void RemoveProvider(object path)        [deprecated]
+
+                       Remove a VPN specified by the object path.
+
                void RegisterAgent(object path)
 
                        Register new agent for handling user requests.
@@ -129,7 +149,7 @@ Methods             dict GetProperties()
                        creation of a tun/tap interface, and IP
                        configuration, NAT and IP forwarding on that
                        interface.
-                       An object path, a dictionnary and a file descriptor
+                       An object path, a dictionary and a file descriptor
                        with IP settings are returned.
 
                        Possible Errors: [service].Error.InvalidArguments
@@ -141,6 +161,44 @@ Methods            dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
+               void RegisterPeerService(dict specification, boolean master)
+                          [experimental]
+
+                       Registers a local P2P Peer service
+
+                       Even if p2p techonology is not available, it will be
+                       possible to register peer services, since a p2p
+                       enabled WiFi device might appear at anytime. The
+                       registered peer services will automatically be enabled
+                       for the p2p WiFi device; the application does not need
+                       to do any re-registration.
+
+                       A Peer service belongs to the process that registers
+                       it, thus if that process dies, its Peer services will
+                       be destroyed as well.
+
+                       The specification dict follows the format described
+                       in the Peer API document.
+
+                       ConnMan will be able to determine in most cases
+                       whether to be the P2P Group Owner or not. If the
+                       service for some reason must belong to a group that
+                       this device manages, the "master" property can be
+                       set. Do not enable the "master" property unless it
+                       is absolutely sure that this is needed for the
+                       provided peer service.
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.AlreadyExists
+                                        [service].Error.NotSupported
+
+               void UnregisterPeerService(dict specification) [experimental]
+
+                       Unregisters an existing local P2P Peer service
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.NotRegistered
+
 Signals                TechnologyAdded(object path, dict properties)
 
                        Signal that is sent when a new technology is added.
@@ -150,18 +208,19 @@ Signals           TechnologyAdded(object path, dict properties)
 
                TechnologyRemoved(object path)
 
-                       Signal that is sent when a modem has been removed.
+                       Signal that is sent when a technology has been removed.
 
                        The object path is no longer accessible after this
                        signal and only emitted for reference.
 
                ServicesChanged(array{object, dict}, array{object})
 
-                       Signals a list of services that have been changed
-                       via the first array. And a list of service that
-                       have been removed via the second array.
+                       This signal indicates a change in the services.
+                       List of all services currently registered is passed
+                       via the first array. And a list of services that have
+                       been removed via the second array.
 
-                       The list of added services is sorted. The dictionary
+                       The list of all services is sorted. The dictionary
                        with the properties might be empty in case none of
                        the properties have changed. Or only contains the
                        properties that have changed.
@@ -178,6 +237,36 @@ Signals            TechnologyAdded(object path, dict properties)
                        required to watch the PropertyChanged signal of
                        the service object.
 
+               PeersChanged(array{object, dict}, array{object}) [experimental]
+
+                       This signal indicates a change in the peers. List of
+                       all peers currently registered is passed via the first
+                       array. And a list of peers that have been removed via
+                       the second array.
+
+                       The list of all peers is sorted. The dictionary
+                       with the properties might be empty in case none of the
+                       properties have changed. Or only contains the
+                       properties that have changed.
+
+                       For newly added peers the whole set of properties will
+                       be present.
+
+                       The list of removed peers can be empty.
+
+                       This signal will only be triggered when the sort order
+                       of the peer list or the number of peers changes. It
+                       will not be emitted if only a property of the peer
+                       object changes. For that it is required to watch the
+                       PropertyChanged signal of the peer object.
+
+               TetheringClientsChanged(array{string}, array{string}) [experimental]
+
+                       This signal indicates a change in the tethering clients.
+                       List of all tethering clients currently registered connman is
+                       passed via the first array. And a list of tethering clients that
+                       have been removed via the second array.
+
                PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given
@@ -193,6 +282,12 @@ Properties string State [readonly]
                        retrieved via the OfflineMode property, but is kept
                        here for consistency and to differentiate from "idle".
 
+                       However when OfflineMode property is true, the State
+                       property can still be "idle", "ready" or "online"
+                       since it is possible by the end user to re-enable
+                       individual technologies like WiFi and Bluetooth while
+                       in offline mode.
+
                        The states "idle", "ready" and "online" match to
                        states from the services. If no service is in
                        either "ready" or "online" state it will indicate
@@ -218,11 +313,9 @@ Properties string State [readonly]
                        the limited usage of WiFi or Bluetooth devices might
                        be allowed in some situations.
 
-               boolean SessionMode [readwrite]  [experminental]
+               boolean SessionMode [readwrite]  [experminental][deprecated]
 
-                       This disables the auto connect feature. It should be
-                       enabled when the Session API is used. When SessionMode
-                       is enabled, 'ConnectService' and 'ConnectProvider'
-                       method calls are disallowed.
+                       This property exists only for compatibility reasons
+                       and does not affect ConnMan in any way.
 
                        The default value is false.