doc/manager-api.txt

   1 BlueZ D-Bus Manager API description
   2 ***********************************
   3
   4 Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
   5 Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com>
   6 Copyright (C) 2005-2006  Claudio Takahasi <claudio.takahasi@indt.org.br>
   7 Copyright (C) 2006-2007  Luiz von Dentz <luiz.dentz@indt.org.br>
   8
   9
  10 Manager hierarchy
  11 =================
  12
  13 Service         org.bluez
  14 Interface       org.bluez.Manager
  15 Object path     /
  16
  17 Methods         dict GetProperties()
  18
  19                         Returns all global properties. See the
  20                         properties section for available properties.
  21
  22                         Possible Errors: org.bluez.Error.DoesNotExist
  23                                          org.bluez.Error.InvalidArguments
  24
  25                 object DefaultAdapter()
  26
  27                         Returns object path for the default adapter.
  28
  29                         Possible errors: org.bluez.Error.InvalidArguments
  30                                          org.bluez.Error.NoSuchAdapter
  31
  32                 object FindAdapter(string pattern)
  33
  34                         Returns object path for the specified adapter. Valid
  35                         patterns are "hci0" or "00:11:22:33:44:55".
  36
  37                         Possible errors: org.bluez.Error.InvalidArguments
  38                                          org.bluez.Error.NoSuchAdapter
  39
  40                 array{object} ListAdapters()
  41
  42                         Returns list of adapter object paths under /org/bluez
  43
  44                         Possible errors: org.bluez.Error.InvalidArguments
  45                                          org.bluez.Error.Failed
  46                                          org.bluez.Error.OutOfMemory
  47
  48 Signals         PropertyChanged(string name, variant value)
  49
  50                         This signal indicates a changed value of the given
  51                         property.
  52
  53                 AdapterAdded(object adapter)
  54
  55                         Parameter is object path of added adapter.
  56
  57                 AdapterRemoved(object adapter)
  58
  59                         Parameter is object path of removed adapter.
  60
  61                 DefaultAdapterChanged(object adapter)
  62
  63                         Parameter is object path of the new default adapter.
  64
  65                         In case all adapters are removed this signal will not
  66                         be emitted. The AdapterRemoved signal has to be used
  67                         to detect that no default adapter is selected or
  68                         available anymore.
  69
  70 Properties      array{object} Adapters [readonly]
  71
  72                         List of adapter object paths.