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 Signals         PropertyChanged(string name, variant value)
 109
 110                         This signal indicates a changed value of the given
 111                         property.
 112
 113                 StateChanged(string state)
 114
 115                         This signal is similar to the PropertyChanged signal
 116                         for the State property.
 117
 118                         It exists for application state only care about the
 119                         current state and so can avoid to be woken up when
 120                         other details changes.
 121
 122 Properties      string State [readonly]
 123
 124                         The global connection state of a system. Possible
 125                         values are "online" if at least one connection exists
 126                         and "offline" if no device is connected.
 127
 128                         In certain situations the state might change to
 129                         the value "connected". This can only be seen if
 130                         previously no connection was present.
 131
 132                 array{string} AvailableTechnologies [readonly]
 133
 134                         The list of available technologies. The strings
 135                         are the same as the ones from the service types.
 136
 137                 array{string} EnabledTechnologies [readonly]
 138
 139                         The list of enabled technologies. The strings
 140                         are the same as the ones from the service types.
 141
 142                 array{string} ConnectedTechnologies [readonly]
 143
 144                         The list of connected technologies. The strings
 145                         are the same as the ones from the service type.
 146
 147                 string DefaultTechnology [readonly]
 148
 149                         The current connected technology which holds the
 150                         default route.
 151
 152                 boolean OfflineMode [readwrite]
 153
 154                         The offline mode indicates the global setting for
 155                         switching all radios on or off. Changing offline mode
 156                         to true results in powering down all devices. When
 157                         leaving offline mode the individual policy of each
 158                         device decides to switch the radio back on or not.
 159
 160                         During offline mode, it is still possible to switch
 161                         certain technologies manually back on. For example
 162                         the limited usage of WiFi or Bluetooth devices might
 163                         be allowed in some situations.
 164
 165                 object ActiveProfile [readwrite]
 166
 167                         Object path of the current active profile.
 168
 169                 array{object} Profiles [readonly]
 170
 171                         List of profile object paths.
 172
 173                 array{object} Devices [readonly]
 174
 175                         List of device object paths.
 176
 177                 array{object} Services [readonly]
 178
 179                         List of service object paths. The list is sorted
 180                         internally to have the service with the default
 181                         route always first and then the favorite services
 182                         followed by scan results.
 183
 184                         This list represents the available services for the
 185                         current selected profile. If the profile gets changed
 186                         then this list will be updated.
 187
 188                         The same list is available via the profile object
 189                         itself. It is just provided here for convenience of
 190                         applications only dealing with the current active
 191                         profile.
 192
 193                 array{object} Connections [readonly]
 194
 195                         List of active connection object paths.