← Back to branch summary

~phablet-team/aethercast/trunk

« back to all changes in this revision

Viewing changes to docs/manager-api.txt

  • Committer: Simon Fels
  • Date: 2015-12-01 09:02:16 UTC
  • mto: This revision was merged to the branch mainline in revision 94.
  • Revision ID: simon.fels@canonical.com-20151201090216-9305yutk42mu7q2s
Add DBus API specification and documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/manager-api.txt
 
1
Manager hierarchy
 
2
=================
 
3
 
 
4
Service         org.wds
 
5
Interface       org.wds.Manager
 
6
Object path     /
 
7
 
 
8
Methods         void Scan()
 
9
 
 
10
                        Trigger a scan for available display devices. The
 
11
                        method call will return when a scan has been
 
12
                        finished and results are available. So setting
 
13
                        a longer D-Bus timeout might be a really good
 
14
                        idea.
 
15
 
 
16
Properties      string State [readonly]
 
17
 
 
18
                        The global connection state. Possible values are
 
19
                        "offline", "idle" and "connected".
 
20
 
 
21
                        If the underlaying transport technology is turned
 
22
                        off the state will be "offline" to reflect we
 
23
                        can't do any operation. All devices will be
 
24
                        disconnected in this state.
 
25
 
 
26
                        When the underlaying transport technology is
 
27
                        turned on and no device is connected the manager
 
28
                        will be in "idle" mode. This marks the manager
 
29
                        as being ready to connect with a remote device.
 
30
 
 
31
                        If atleast one device is connected the state
 
32
                        will be "connected".