git.maemo.org Git - connman/blob - doc/network-api.txt

   1 Network hierarchy
   2 =================
   3
   4 Service         org.moblin.connman
   5 Interface       org.moblin.connman.Network
   6 Object path     [variable prefix]/{network0,network1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the network object. See
  11                         the properties section for available properties.
  12
  13                         Possible Errors: [service].Error.InvalidArguments
  14
  15                 void SetProperty(string name, variant value)
  16
  17                         Changes the value of the specified property. Only
  18                         properties that are listed as read-write are
  19                         changeable. On success a PropertyChanged signal
  20                         will be emitted.
  21
  22                         Possible Errors: [service].Error.InvalidArguments
  23                                          [service].Error.DoesNotExist
  24
  25 Signals         PropertyChanged(string name, variant value)
  26
  27                         This signal indicates a changed value of the given
  28                         property.
  29
  30 Properties      string Address [readonly]
  31
  32                         The address of the network.
  33
  34                 string Name [readonly]
  35
  36                         The pretty/long version of the network name. For
  37                         example in case of WiFi this should be the UTF-8
  38                         valid version of the SSID.
  39
  40                         This property might not be available for every
  41                         network. For example hidden WiFi networks will
  42                         not include it.
  43
  44                 boolean Connected [readonly]
  45
  46                         Indicates that this network is currently connected.
  47
  48                 uint8 Strength [readonly]
  49
  50                         Indicates the signal strength of the network. This
  51                         is a normalized value between 0 and 100.
  52
  53                 object Device [readonly]
  54
  55                         The object path of the device this networks
  56                         belongs to.
  57
  58                 array{byte} WiFi.SSID [readonly]
  59
  60                         If the network type is WiFi, then this property is
  61                         present and contains the binary SSID value.
  62
  63                 string WiFi.Mode [readonly, readwrite]
  64
  65                         If the network type is WiFi, then this property is
  66                         present and contains the mode of the network. The
  67                         possible values are "managed" or "adhoc".
  68
  69                         For scanned networks this value is read only, but in
  70                         case the network was manually created it is also
  71                         changeable.
  72
  73                 string WiFi.Security [readonly, readwrite]
  74
  75                         If the network type is WiFi, then this property is
  76                         present and contains the security method or key
  77                         management setting.
  78
  79                         For scanned networks this value is read only, but in
  80                         case the network was manually created it is also
  81                         changeable.
  82
  83                         Possible values are "none", "wep", "wpa" and "rsn".
  84
  85                 string WiFi.Passphrase [readwrite]
  86
  87                         If the network type is WiFi and a passhrase is
  88                         requires, then this property is present and contains
  89                         the passphrase in clear text.
  90
  91                         For systems using PolicyKit, the access to this value
  92                         will be protected by the security policy.