doc/service-api.txt

   1 Service hierarchy
   2 =================
   3
   4 Service         org.moblin.connman
   5 Interface       org.moblin.connman.Service
   6 Object path     [variable prefix]/{service0,service1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the service 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                 void Connect()
  26
  27                         Connect this service. It will attempt to connect
  28                         WiFi, WiMAX or Bluetooth services.
  29
  30                         For Ethernet devices this method can only be used
  31                         if it has previously been disconnected. Otherwise
  32                         the plugging of a cable will trigger connecting
  33                         automatically. If no cable is plugged in this method
  34                         will fail.
  35
  36                         Possible Errors: [service].Error.InvalidArguments
  37
  38                 void Disconnect()
  39
  40                         Disconnect this service. If the service is not
  41                         connected an error message will be generated.
  42
  43                         On Ethernet devices this will disconnect the IP
  44                         details from the service. It will not magically
  45                         unplug the cable. When no cable is plugged in this
  46                         method will fail.
  47
  48                         Possible Errors: [service].Error.InvalidArguments
  49
  50                 void Remove()
  51
  52                         A successfully connected service with Favorite=true
  53                         can be removed this way. If it is connected, it will
  54                         be automatically disconnected first.
  55
  56                         This is similar to setting the Favorite property
  57                         to false, but that is currently not supported.
  58
  59                         Calling this method on Ethernet devices will cause
  60                         an error message. It is not possible to remove these
  61                         kind of devices.
  62
  63                         Possible Errors: [service].Error.InvalidArguments
  64
  65                 void MoveBefore(object service)
  66
  67                         If a service has been used before, this allows a
  68                         reorder of the favorite services.
  69
  70                         The target service object must be part of this
  71                         profile. Moving between profiles is not supported.
  72
  73                         Possible Errors: [service].Error.InvalidArguments
  74
  75                 void MoveAfter(object service)
  76
  77                         If a service has been used before, this allows a
  78                         reorder of the favorite services.
  79
  80                         The target service object must be part of this
  81                         profile. Moving between profiles is not supported.
  82
  83                         Possible Errors: [service].Error.InvalidArguments
  84
  85 Signals         PropertyChanged(string name, variant value)
  86
  87                         This signal indicates a changed value of the given
  88                         property.
  89
  90 Properties      string State [readonly]
  91
  92                         The service state information.
  93
  94                         Valid states are "idle", "failure", "association",
  95                         "configuration" and "ready".
  96
  97                 string Error [readonly]
  98
  99                         The service error status details.
 100
 101                         When error occur during connection or disconnection
 102                         the detailed information are represented in this
 103                         property to help the user interface to present the
 104                         user with alternate options.
 105
 106                         This property is only valid when the service is in
 107                         the "failure" state. Otherwise it might be empty or
 108                         not present at all.
 109
 110                         Current defined error code is "dhcp-failed".
 111
 112                 string Name [readonly]
 113
 114                         The service name (for example "Wireless" etc.)
 115
 116                         This name can be used for directly displaying it in
 117                         the application. It has pure informational purpose.
 118
 119                         For Ethernet devices and hidden WiFi networks it is
 120                         not guaranteed that this property is present.
 121
 122                 string Type [readonly]
 123
 124                         The service type (for example "ethernet", "wifi" etc.)
 125
 126                         This information should only be used to determine
 127                         advanced properties or showing the correct icon
 128                         to the user.
 129
 130                 string Mode [readonly]
 131
 132                         If the service type is WiFi, then this property is
 133                         present and contains the mode of the network. The
 134                         possible values are "managed" or "adhoc".
 135
 136                         This property might be only present for WiFi
 137                         services.
 138
 139                 string Security [readonly]
 140
 141                         If the service type is WiFi, then this property is
 142                         present and contains the security method or key
 143                         management setting.
 144
 145                         Possible values are "none", "wep", "wpa" and "rsn".
 146
 147                         This property might be only present for WiFi
 148                         services.
 149
 150                 string Passphrase [readwrite]
 151
 152                         If the service type is WiFi, then this property
 153                         can be used to store a passphrase.
 154
 155                         This property is still experimental and might be
 156                         removed in future version.
 157
 158                 uint8 Strength [readonly]
 159
 160                         Indicates the signal strength of the service. This
 161                         is a normalized value between 0 and 100.
 162
 163                         This property will not be present for Ethernet
 164                         devices.
 165
 166                 boolean Favorite [readonly]
 167
 168                         Will be true if a cable is plugged in or the user
 169                         selected and successfully connected to this service.
 170
 171                         Setting this property to true has no effect at all
 172                         and setting it to false is similar to the Remove()
 173                         method. So for now it will be considered a read
 174                         only property.
 175
 176                 string IPv4.Method [readwrite]
 177
 178                         The IPv4 configuration method. Possible values here
 179                         are "dhcp" and "static".
 180
 181                 string IPv4.Address [readwrite]
 182
 183                         The current configured IPv4 address.