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 AddProfile(string name)
  33
  34                         Add a new profile with the specified name.
  35
  36                         It is possible to create two profiles with the same
  37                         name. The identification is done via the object path
  38                         and not the name of the profile.
  39
  40                         Possible Errors: [service].Error.InvalidArguments
  41
  42                 void RemoveProfile(object path)
  43
  44                         Remove profile with specified object path.
  45
  46                         It is not possible to remove the current active
  47                         profile. To remove the active profile a different
  48                         one must be selected via ActiveProfile property
  49                         first.
  50
  51                         At minimum one profile must be available all the time.
  52
  53                         Possible Errors: [service].Error.InvalidArguments
  54
  55                 void RequestScan(string type)
  56
  57                         Request to trigger a scan for the specified
  58                         technology. The empty string "" triggers scanning
  59                         on all technologies.
  60
  61                         Possible Errors: [service].Error.InvalidArguments
  62
  63                 void EnableTechnology(string type)
  64
  65                         Enable specified type of technologies.
  66
  67                         Possible Errors: [service].Error.InvalidArguments
  68
  69                 void DisableTechnology(string type)
  70
  71                         Disable specified type of technologies.
  72
  73                         Possible Errors: [service].Error.InvalidArguments
  74
  75                 object ConnectService(dict network)
  76
  77                         Connect to a network specified by the given
  78                         properties.
  79
  80                         For connecting to a hidden WiFi network for example
  81                         it is required that Type = "wifi" and the SSID
  82                         properties are provided.
  83
  84                         When successful this method will return object
  85                         path of the service object.
  86
  87                         This method can also be used to connect to an
  88                         already existing service. It works exactly the
  89                         same as executing the Connect method from the
  90                         service interface.
  91
  92                         This method call will only return in case of an
  93                         error or when the service is fully connected. So
  94                         setting a longer D-Bus timeout might be a really
  95                         good idea.
  96
  97                         Possible Errors: [service].Error.InvalidArguments
  98
  99                 void RegisterAgent(object path)
 100
 101                         Register new agent for handling user requests.
 102
 103                         Possible Errors: [service].Error.InvalidArguments
 104
 105                 void UnregisterAgent(object path)
 106
 107                         Unregister an existing agent.
 108
 109                         Possible Errors: [service].Error.InvalidArguments
 110
 111 Signals         PropertyChanged(string name, variant value)
 112
 113                         This signal indicates a changed value of the given
 114                         property.
 115
 116                 StateChanged(string state)
 117
 118                         This signal is similar to the PropertyChanged signal
 119                         for the State property.
 120
 121                         It exists for application state only care about the
 122                         current state and so can avoid to be woken up when
 123                         other details changes.
 124
 125 Properties      string State [readonly]
 126
 127                         The global connection state of a system. Possible
 128                         values are "online" if at least one connection exists
 129                         and "offline" if no device is connected.
 130
 131                         In certain situations the state might change to
 132                         the value "connected". This can only be seen if
 133                         previously no connection was present.
 134
 135                 array{string} AvailableTechnologies [readonly]
 136
 137                         The list of available technologies. The strings
 138                         are the same as the ones from the service types.
 139
 140                 array{string} EnabledTechnologies [readonly]
 141
 142                         The list of enabled technologies. The strings
 143                         are the same as the ones from the service types.
 144
 145                 array{string} ConnectedTechnologies [readonly]
 146
 147                         The list of connected technologies. The strings
 148                         are the same as the ones from the service type.
 149
 150                 string DefaultTechnology [readonly]
 151
 152                         The current connected technology which holds the
 153                         default route.
 154
 155                 boolean OfflineMode [readwrite]
 156
 157                         The offline mode indicates the global setting for
 158                         switching all radios on or off. Changing offline mode
 159                         to true results in powering down all devices. When
 160                         leaving offline mode the individual policy of each
 161                         device decides to switch the radio back on or not.
 162
 163                         During offline mode, it is still possible to switch
 164                         certain technologies manually back on. For example
 165                         the limited usage of WiFi or Bluetooth devices might
 166                         be allowed in some situations.
 167
 168                 object ActiveProfile [readwrite]
 169
 170                         Object path of the current active profile.
 171
 172                 array{object} Profiles [readonly]
 173
 174                         List of profile object paths.
 175
 176                 array{object} Devices [readonly]
 177
 178                         List of device object paths.
 179
 180                 array{object} Services [readonly]
 181
 182                         List of service object paths. The list is sorted
 183                         internally to have the service with the default
 184                         route always first and then the favorite services
 185                         followed by scan results.
 186
 187                         This list represents the available services for the
 188                         current selected profile. If the profile gets changed
 189                         then this list will be updated.
 190
 191                         The same list is available via the profile object
 192                         itself. It is just provided here for convenience of
 193                         applications only dealing with the current active
 194                         profile.
 195
 196                 array{object} Connections [readonly]
 197
 198                         List of active connection object paths.