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