summaryrefslogtreecommitdiff
path: root/doc/manager-api.txt
blob: d2c1cafe46b6535efd6c2d9ebf968feba122e25b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
BlueZ D-Bus Manager API description
***********************************

Copyright (C) 2004-2010  Marcel Holtmann <marcel@holtmann.org>
Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com>
Copyright (C) 2005-2006  Claudio Takahasi <claudio.takahasi@indt.org.br>
Copyright (C) 2006-2007  Luiz von Dentz <luiz.dentz@indt.org.br>


Manager hierarchy
=================

Service		org.bluez
Interface	org.bluez.Manager
Object path	/

Methods		dict GetProperties()

			Returns all global properties. See the
			properties section for available properties.

			Possible Errors: org.bluez.Error.DoesNotExist
					 org.bluez.Error.InvalidArguments

		object DefaultAdapter()

			Returns object path for the default adapter.

			Possible errors: org.bluez.Error.InvalidArguments
					 org.bluez.Error.NoSuchAdapter

		object FindAdapter(string pattern)

			Returns object path for the specified adapter. Valid
			patterns are "hci0" or "00:11:22:33:44:55".

			Possible errors: org.bluez.Error.InvalidArguments
					 org.bluez.Error.NoSuchAdapter

		array{object} ListAdapters() {deprecated}

			Returns list of adapter object paths under /org/bluez.
			This method is deprecated, instead use the Adapters
			Property to get the list of adapter object paths.

			Possible errors: org.bluez.Error.InvalidArguments
					 org.bluez.Error.Failed
					 org.bluez.Error.OutOfMemory

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

		AdapterAdded(object adapter)

			Parameter is object path of added adapter.

		AdapterRemoved(object adapter)

			Parameter is object path of removed adapter.

		DefaultAdapterChanged(object adapter)

			Parameter is object path of the new default adapter.

			In case all adapters are removed this signal will not
			be emitted. The AdapterRemoved signal has to be used
			to detect that no default adapter is selected or
			available anymore.

Properties	array{object} Adapters [readonly]

			List of adapter object paths.