doc/dundee-api.txt

   1
   2 Manager hierarchy
   3 =================
   4
   5 Service         org.ofono.dundee
   6 Interface       org.ofono.dundee.Manager
   7 Object path     /
   8
   9 Methods         array{object,dict} GetDevices()
  10
  11                         Get an array of device objects and properties
  12                         that represent the currently attached devices.
  13
  14                         This method call should only be used once when an
  15                         application starts up. Further device additions
  16                         and removal shall be monitored via DeviceAdded and
  17                         DeviceRemoved signals.
  18
  19 Signals         DeviceAdded(object path, dict properties)
  20
  21                         Signal that is sent when a new device is added.  It
  22                         contains the object path of new device and its
  23                         properties.
  24
  25                 DeviceRemoved(object path)
  26
  27                         Signal that is sent when a device has been removed.
  28                         The object path is no longer accessible after this
  29                         signal and only emitted for reference.
  30
  31
  32 Device hierarchy
  33 ================
  34
  35 Service         org.ofono.dundee
  36 Interface       org.ofono.dundee.Device
  37 Object path     /{device0,device1,...}
  38
  39 Methods         dict GetProperties()
  40
  41                         Returns properties for the device object. See
  42                         the properties section for available properties.
  43
  44 Signals         PropertyChanged(string name, variant value)
  45
  46                         This signal indicates a changed value of the given
  47                         property.
  48
  49 Properties      string Name [readonly]
  50
  51                         Friendly name of the device.
  52
  53                 boolean Active [readwrite]
  54
  55                         Holds whether the device is connected. A
  56                         connection will be established when this value
  57                         is set to true. A existing connection will be
  58                         teared down when set to false.
  59
  60                 dict Settings [readonly]
  61
  62                         Holds all the IP network settings.
  63
  64                         string Interface [readonly, optional]
  65
  66                                 Holds the interface of the network interface
  67                                 used by this connection (e.g. "ppp0" "usb0")
  68
  69                         string Address [readonly, optional]
  70
  71                                 Holds the IP address for this connection.
  72
  73                         array{string} DomainNameServers [readonly, optional]
  74
  75                                 Holds the list of domain name servers for this
  76                                 connection.