doc: Make session methods as experimental for now
[platform/upstream/connman.git] / doc / manager-api.txt
index c247d9f..02fd89d 100644 (file)
@@ -22,13 +22,6 @@ Methods              dict GetProperties()
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.InvalidProperty
 
-               string GetState()
-
-                       Return global connection state of a system. The
-                       same value is return via the State property.
-
-                       Possible Errors: [service].Error.InvalidArguments
-
                void RequestScan(string type)
 
                        Request to trigger a scan for the specified
@@ -59,55 +52,6 @@ Methods              dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
-               object LookupService(string pattern)
-
-                       Lookup a service matching the specific pattern.
-
-                       Examples are interface names like "eth0", "wlan0"
-                       etc. or service names like "hotspot" etc.
-
-                       In case of multiple services match the the pattern
-                       an error is returned.
-
-                       Possible Errors: [service].Error.InvalidArguments
-                                        [service].Error.NotUnique
-                                        [service].Error.NotFound
-
-               object ConnectService(dict network)
-
-                       Connect to a network specified by the given
-                       properties.
-
-                       For connecting to a hidden WiFi network for example
-                       it is required that Type = "wifi" and the SSID
-                       properties are provided.
-
-                       When successful this method will return object
-                       path of the service object.
-
-                       This method can also be used to connect to an
-                       already existing service. It works exactly the
-                       same as executing the Connect method from the
-                       service interface.
-
-                       This method call will only return in case of an
-                       error or when the service is fully connected. So
-                       setting a longer D-Bus timeout might be a really
-                       good idea.
-
-                       Possible Errors: [service].Error.InvalidArguments
-
-               void ProvisionService(string configuration)
-
-                       Provide a configuration for services.
-
-                       Service configuration is provided as a single string
-                       that follows the same format as configuration files,
-                       see config-format.txt. An exception to this format
-                       is that only one service can be provisioned per call.
-
-                       Possible Errors: [service].Error.InvalidArguments
-
                object ConnectProvider(dict provider)
 
                        Connect to a VPN specified by the given provider
@@ -124,6 +68,9 @@ Methods              dict GetProperties()
                        setting a longer D-Bus timeout might be a really
                        good idea.
 
+                       When 'SessionMode' property is enabled, this method
+                       call is disallowed.
+
                        Possible Errors: [service].Error.InvalidArguments
 
                void RegisterAgent(object path)
@@ -138,7 +85,7 @@ Methods              dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
-               void RegisterCounter(object path, uint32 accuracy, uint32 period)
+               void RegisterCounter(object path, uint32 accuracy, uint32 period)  [experimental]
 
                        Register a new counter for user notifications.
 
@@ -159,13 +106,13 @@ Methods           dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
-               void UnregisterCounter(object path)
+               void UnregisterCounter(object path)  [experimental]
 
                        Unregister an existing counter.
 
                        Possible Errors: [service].Error.InvalidArguments
 
-               object CreateSession(dict settings, object notifier)
+               object CreateSession(dict settings, object notifier)  [experimental]
 
                        Create a new session for the application. Every
                        application can create multiple session with
@@ -181,22 +128,36 @@ Methods           dict GetProperties()
                        Every application should at least create one session
                        to inform about its requirements and it purpose.
 
-               void DestroySession(object session)
+               void DestroySession(object session)  [experimental]
 
-                       Remove the previously created session. The notifier
-                       will be informed via its release method.
+                       Remove the previously created session.
 
                        If an application exits unexpectatly the session
                        will be automatically destroyed.
 
-               StateChanged(string state)
+               object path, dict, fd RequestPrivateNetwork(dict options)
+                                                               [experimental]
 
-                       This signal is similar to the PropertyChanged signal
-                       for the State property.
+                       Request a new Private Network, which includes the
+                       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
+                       with IP settings are returned.
 
-                       It exists for application state only care about the
-                       current state and so can avoid to be woken up when
-                       other details changes.
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.NotSupported
+
+               void ReleasePrivateNetwork(object path) [experimental]
+
+                       Releases a private network.
+
+                       Possible Errors: [service].Error.InvalidArguments
+
+Signals                PropertyChanged(string name, variant value)
+
+                       This signal indicates a changed value of the given
+                       property.
 
 Properties     string State [readonly]
 
@@ -241,10 +202,6 @@ Properties string State [readonly]
                        the limited usage of WiFi or Bluetooth devices might
                        be allowed in some situations.
 
-               object ActiveProfile [readwrite]
-
-                       Object path of the current active profile.
-
                array{object} Technologies [readonly]
 
                        List of technology object paths.
@@ -265,9 +222,11 @@ Properties string State [readonly]
                        applications only dealing with the current active
                        profile.
 
-               boolean SessionMode [readwrite]
+               boolean SessionMode [readwrite]  [experminental]
 
                        This disables the auto connect feature. It should be
-                       enabled when the Session API is used.
+                       enabled when the Session API is used. When SessionMode
+                       is enabled, 'ConnectService' and 'ConnectProvider'
+                       method calls are disallowed.
 
                        The default value is false.