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                 object ConnectService(dict network)
  57
  58                         Connect to a network specified by the given
  59                         properties.
  60
  61                         For connecting to a hidden WiFi network for example
  62                         it is required that Type = "wifi" and the SSID
  63                         properties are provided.
  64
  65                         When successful this method will return object
  66                         path of the service object.
  67
  68                         This method can also be used to connect to an
  69                         already existing service. It works exactly the
  70                         same as executing the Connect method from the
  71                         service interface.
  72
  73                         Possible Errors: [service].Error.InvalidArguments
  74
  75                 void RegisterAgent(object path)
  76
  77                         Register new agent for handling user requests.
  78
  79                         Possible Errors: [service].Error.InvalidArguments
  80
  81                 void UnregisterAgent(object path)
  82
  83                         Unregister an existing agent.
  84
  85                         Possible Errors: [service].Error.InvalidArguments
  86
  87 Signals         PropertyChanged(string name, variant value)
  88
  89                         This signal indicates a changed value of the given
  90                         property.
  91
  92                 StateChanged(string state)
  93
  94                         This signal is similar to the PropertyChanged signal
  95                         for the State property.
  96
  97                         It exists for application state only care about the
  98                         current state and so can avoid to be woken up when
  99                         other details changes.
 100
 101 Properties      string State [readonly]
 102
 103                         The global connection state of a system. Possible
 104                         values are "online" if at least one connection exists
 105                         and "offline" if no device is connected.
 106
 107                         In certain situations the state might change to
 108                         the value "connected". This can only be seen if
 109                         previously no connection was present.
 110
 111                 boolean OfflineMode [readwrite]
 112
 113                         The offline mode indicates the global setting for
 114                         switching all radios on or off. Changing offline mode
 115                         to true results in powering down all devices. When
 116                         leaving offline mode the individual policy of each
 117                         device decides to switch the radio back on or not.
 118
 119                         During offline mode, it is still possible to switch
 120                         certain technologies manually back on. For example
 121                         the limited usage of WiFi or Bluetooth devices might
 122                         be allowed in some situations.
 123
 124                 object ActiveProfile [readwrite]
 125
 126                         Object path of the current active profile.
 127
 128                 array{object} Profiles [readonly]
 129
 130                         List of profile object paths.
 131
 132                 array{object} Devices [readonly]
 133
 134                         List of device object paths.
 135
 136                 array{object} Services [readonly]
 137
 138                         List of service object paths. The list is sorted
 139                         internally to have the service with the default
 140                         route always first and then the favorite services
 141                         followed by scan results.
 142
 143                         This list represents the available services for the
 144                         current selected profile. If the profile gets changed
 145                         then this list will be updated.
 146
 147                         The same list is available via the profile object
 148                         itself. It is just provided here for convenience of
 149                         applications only dealing with the current active
 150                         profile.
 151
 152                 array{object} Connections [readonly]
 153
 154                         List of active connection object paths.