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                 object ConnectService(dict network)
  73
  74                         Connect to a network specified by the given
  75                         properties.
  76
  77                         For connecting to a hidden WiFi network for example
  78                         it is required that Type = "wifi" and the SSID
  79                         properties are provided.
  80
  81                         When successful this method will return object
  82                         path of the service object.
  83
  84                         This method can also be used to connect to an
  85                         already existing service. It works exactly the
  86                         same as executing the Connect method from the
  87                         service interface.
  88
  89                         This method call will only return in case of an
  90                         error or when the service is fully connected. So
  91                         setting a longer D-Bus timeout might be a really
  92                         good idea.
  93
  94                         Possible Errors: [service].Error.InvalidArguments
  95
  96                 void RegisterAgent(object path)
  97
  98                         Register new agent for handling user requests.
  99
 100                         Possible Errors: [service].Error.InvalidArguments
 101
 102                 void UnregisterAgent(object path)
 103
 104                         Unregister an existing agent.
 105
 106                         Possible Errors: [service].Error.InvalidArguments
 107
 108                 void RegisterCounter(object path, uint32 interval)
 109
 110                         Register a new counter for user notifications.
 111
 112                         If the interval is zero then no timer for updates
 113                         will be started. Only kernel events can then
 114                         trigger updates. Otherwise the kernel will be
 115                         polled every n seconds for an update.
 116
 117                         Possible Errors: [service].Error.InvalidArguments
 118
 119                 void UnregisterCounter(object path)
 120
 121                         Unregister an existing counter.
 122
 123                         Possible Errors: [service].Error.InvalidArguments
 124
 125 Signals         PropertyChanged(string name, variant value)
 126
 127                         This signal indicates a changed value of the given
 128                         property.
 129
 130                 StateChanged(string state)
 131
 132                         This signal is similar to the PropertyChanged signal
 133                         for the State property.
 134
 135                         It exists for application state only care about the
 136                         current state and so can avoid to be woken up when
 137                         other details changes.
 138
 139 Properties      string State [readonly]
 140
 141                         The global connection state of a system. Possible
 142                         values are "online" if at least one connection exists
 143                         and "offline" if no device is connected.
 144
 145                         In certain situations the state might change to
 146                         the value "connected". This can only be seen if
 147                         previously no connection was present.
 148
 149                 array{string} AvailableTechnologies [readonly]
 150
 151                         The list of available technologies. The strings
 152                         are the same as the ones from the service types.
 153
 154                 array{string} EnabledTechnologies [readonly]
 155
 156                         The list of enabled technologies. The strings
 157                         are the same as the ones from the service types.
 158
 159                 array{string} ConnectedTechnologies [readonly]
 160
 161                         The list of connected technologies. The strings
 162                         are the same as the ones from the service type.
 163
 164                 string DefaultTechnology [readonly]
 165
 166                         The current connected technology which holds the
 167                         default route.
 168
 169                 boolean OfflineMode [readwrite]
 170
 171                         The offline mode indicates the global setting for
 172                         switching all radios on or off. Changing offline mode
 173                         to true results in powering down all devices. When
 174                         leaving offline mode the individual policy of each
 175                         device decides to switch the radio back on or not.
 176
 177                         During offline mode, it is still possible to switch
 178                         certain technologies manually back on. For example
 179                         the limited usage of WiFi or Bluetooth devices might
 180                         be allowed in some situations.
 181
 182                 object ActiveProfile [readwrite]
 183
 184                         Object path of the current active profile.
 185
 186                 array{object} Profiles [readonly]
 187
 188                         List of profile object paths.
 189
 190                 array{object} Devices [readonly]
 191
 192                         List of device object paths.
 193
 194                 array{object} Services [readonly]
 195
 196                         List of service object paths. The list is sorted
 197                         internally to have the service with the default
 198                         route always first and then the favorite services
 199                         followed by scan results.
 200
 201                         This list represents the available services for the
 202                         current selected profile. If the profile gets changed
 203                         then this list will be updated.
 204
 205                         The same list is available via the profile object
 206                         itself. It is just provided here for convenience of
 207                         applications only dealing with the current active
 208                         profile.