doc/manager-api.txt

   1 Manager hierarchy
   2 =================
   3
   4 Service         org.moblin.connman
   5 Interface       org.moblin.connman.Manager
   6 Object path     /
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns all global system properties. See the
  11                         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.InvalidProperty
  24
  25                 string GetState()
  26
  27                         Return global connection state of a system. The
  28                         same value is return via the State property.
  29
  30                         Possible Errors: [service].Error.InvalidArguments
  31
  32                 object CreateProfile(string name)
  33
  34                         Create and add new profile with the specified
  35                         identifier name.
  36
  37                         Possible Errors: [service].Error.InvalidArguments
  38
  39                 void RemoveProfile(object path)
  40
  41                         Remove profile with specified object path.
  42
  43                         It is not possible to remove the current active
  44                         profile. To remove the active profile a different
  45                         one must be selected via ActiveProfile property
  46                         first.
  47
  48                         At minimum one profile must be available all the time.
  49
  50                         Possible Errors: [service].Error.InvalidArguments
  51
  52                 void RequestScan(string type)
  53
  54                         Request to trigger a scan for the specified
  55                         technology. The empty string "" triggers scanning
  56                         on all technologies.
  57
  58                         Possible Errors: [service].Error.InvalidArguments
  59
  60                 void EnableTechnology(string type)
  61
  62                         Enable specified type of technologies.
  63
  64                         Possible Errors: [service].Error.InvalidArguments
  65
  66                 void DisableTechnology(string type)
  67
  68                         Disable specified type of technologies.
  69
  70                         Possible Errors: [service].Error.InvalidArguments
  71
  72                 arracy{object,dict} GetServices()
  73
  74                         Returns a sorted list of tuples with service
  75                         object path and dictionary of service properties.
  76
  77                         This list will not contain sensitive information
  78                         like passphrases etc.
  79
  80                         Possible Errors: [service].Error.InvalidArguments
  81
  82                 object LookupService(string pattern)
  83
  84                         Lookup a service matching the specific pattern.
  85
  86                         Examples are interface names like "eth0", "wlan0"
  87                         etc. or service names like "hotspot" etc.
  88
  89                         In case of multiple services match the the pattern
  90                         an error is returned.
  91
  92                         Possible Errors: [service].Error.InvalidArguments
  93                                          [service].Error.NotUnique
  94                                          [service].Error.NotFound
  95
  96                 object ConnectService(dict network)
  97
  98                         Connect to a network specified by the given
  99                         properties.
 100
 101                         For connecting to a hidden WiFi network for example
 102                         it is required that Type = "wifi" and the SSID
 103                         properties are provided.
 104
 105                         When successful this method will return object
 106                         path of the service object.
 107
 108                         This method can also be used to connect to an
 109                         already existing service. It works exactly the
 110                         same as executing the Connect method from the
 111                         service interface.
 112
 113                         This method call will only return in case of an
 114                         error or when the service is fully connected. So
 115                         setting a longer D-Bus timeout might be a really
 116                         good idea.
 117
 118                         Possible Errors: [service].Error.InvalidArguments
 119
 120                 void RegisterAgent(object path)
 121
 122                         Register new agent for handling user requests.
 123
 124                         Possible Errors: [service].Error.InvalidArguments
 125
 126                 void UnregisterAgent(object path)
 127
 128                         Unregister an existing agent.
 129
 130                         Possible Errors: [service].Error.InvalidArguments
 131
 132                 void RegisterCounter(object path, uint32 accuracy, uint32 period)
 133
 134                         Register a new counter for user notifications.
 135
 136                         The accuracy is specified in kilo-bytes and defines
 137                         a threshold for counter updates. Together with the
 138                         period value it defines how often user space needs
 139                         to be updated. The period value is in seconds.
 140
 141                         This interface is not meant for time tracking. If
 142                         the time needs to be tracked down to the second, it
 143                         is better to have a real timer running inside the
 144                         application than using this interface.
 145
 146                         Also getting notified for every kilo-byte is a bad
 147                         choice (even if the interface supports it). Something
 148                         like 10 kilo-byte units or better 1 mega-byte seems
 149                         to be a lot more reasonable and better for the user.
 150
 151                         Possible Errors: [service].Error.InvalidArguments
 152
 153                 void UnregisterCounter(object path)
 154
 155                         Unregister an existing counter.
 156
 157                         Possible Errors: [service].Error.InvalidArguments
 158
 159                 object RequestSession(string bearer)
 160
 161                         Request a networking session.
 162
 163                         If the bearer is an empty string the best available
 164                         service will be picked.
 165
 166                         When successful this method will return the object
 167                         path of the corresponding service.
 168
 169                         Possible Errors: [service].Error.InvalidArguments
 170
 171                 void ReleaseSession()
 172
 173                         Release a networking session.
 174
 175                         Possible Errors: [service].Error.InvalidArguments
 176
 177 Signals         PropertyChanged(string name, variant value)
 178
 179                         This signal indicates a changed value of the given
 180                         property.
 181
 182                 StateChanged(string state)
 183
 184                         This signal is similar to the PropertyChanged signal
 185                         for the State property.
 186
 187                         It exists for application state only care about the
 188                         current state and so can avoid to be woken up when
 189                         other details changes.
 190
 191 Properties      string State [readonly]
 192
 193                         The global connection state of a system. Possible
 194                         values are "online" if at least one connection exists
 195                         and "offline" if no device is connected.
 196
 197                         In certain situations the state might change to
 198                         the value "connected". This can only be seen if
 199                         previously no connection was present.
 200
 201                 array{string} AvailableTechnologies [readonly]
 202
 203                         The list of available technologies. The strings
 204                         are the same as the ones from the service types.
 205
 206                 array{string} EnabledTechnologies [readonly]
 207
 208                         The list of enabled technologies. The strings
 209                         are the same as the ones from the service types.
 210
 211                 array{string} ConnectedTechnologies [readonly]
 212
 213                         The list of connected technologies. The strings
 214                         are the same as the ones from the service type.
 215
 216                 string DefaultTechnology [readonly]
 217
 218                         The current connected technology which holds the
 219                         default route.
 220
 221                 boolean OfflineMode [readwrite]
 222
 223                         The offline mode indicates the global setting for
 224                         switching all radios on or off. Changing offline mode
 225                         to true results in powering down all devices. When
 226                         leaving offline mode the individual policy of each
 227                         device decides to switch the radio back on or not.
 228
 229                         During offline mode, it is still possible to switch
 230                         certain technologies manually back on. For example
 231                         the limited usage of WiFi or Bluetooth devices might
 232                         be allowed in some situations.
 233
 234                 boolean Tethering [readwrite]
 235
 236                         This option allows to enable or disable the support
 237                         for tethering. When tethering is enabled then the
 238                         default service is bridged to all client where
 239                         connection sharing is supported.
 240
 241                 object ActiveProfile [readwrite]
 242
 243                         Object path of the current active profile.
 244
 245                 array{object} Profiles [readonly]
 246
 247                         List of profile object paths.
 248
 249                 array{object} Technologies [readonly]
 250
 251                         List of technology object paths.
 252
 253                 array{object} Services [readonly]
 254
 255                         List of service object paths. The list is sorted
 256                         internally to have the service with the default
 257                         route always first and then the favorite services
 258                         followed by scan results.
 259
 260                         This list represents the available services for the
 261                         current selected profile. If the profile gets changed
 262                         then this list will be updated.
 263
 264                         The same list is available via the profile object
 265                         itself. It is just provided here for convenience of
 266                         applications only dealing with the current active
 267                         profile.