path: root/doc/manager-api.txt
diff options
authorMarcel Holtmann <>2011-03-31 10:02:24 +0200
committerSamuel Ortiz <>2011-03-31 12:28:47 +0200
commit2d1d20c887192944ce6da3cc5e5b8c23ed3860db (patch)
treedc46f4103c6c71b25d79e9817b15778df1ab0472 /doc/manager-api.txt
parentcdb087d5765682578a1fbf0067ef9950ff79f46b (diff)
session: Update documentation
Diffstat (limited to 'doc/manager-api.txt')
1 files changed, 17 insertions, 16 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 332f6cda..c92c2957 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -174,28 +174,29 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
- object RequestSession(string bearer)
+ object CreateSession(dict settings, object notifier)
- Request a networking session.
+ Create a new session for the application. Every
+ application can create multiple session with
+ different settings. The settings are described
+ as part of the session interface.
- If the bearer is an empty string the best available
- service will be picked.
+ The notifier allows asynchronous notification about
+ session specific changes. These changes can be
+ for online/offline state or IP address changes or
+ similar things the application is required to
+ handle.
- When successful this method will return the object
- path of the corresponding service.
- Possible Errors: [service].Error.InvalidArguments
+ Every application should at least create one session
+ to inform about its requirements and it purpose.
- void ReleaseSession()
- Release a networking session.
- Possible Errors: [service].Error.InvalidArguments
+ void DestroySession(object session)
-Signals PropertyChanged(string name, variant value)
+ Remove the previously created session. The notifier
+ will be informed via its release method.
- This signal indicates a changed value of the given
- property.
+ If an application exits unexpectatly the session
+ will be automatically destroyed.
StateChanged(string state)