vcs.maemo.org Git - connman/blob - 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.DoesNotExist
  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 RegisterAgent(object path)
  49
  50                         Register new agent for handling user requests.
  51
  52                         Possible Errors: [service].Error.InvalidArguments
  53
  54                 void UnregisterAgent(object path)
  55
  56                         Unregister an existing agent.
  57
  58                         Possible Errors: [service].Error.InvalidArguments
  59
  60 Signals         PropertyChanged(string name, variant value)
  61
  62                         This signal indicates a changed value of the given
  63                         property.
  64
  65 Properties      string State [readonly]
  66
  67                         The global connection state of a system. Possible
  68                         values are "online" if at least one connection exists
  69                         and "offline" if no device is connected.
  70
  71                         In certain situations the state might change to
  72                         the value "connected". This can only be seen if
  73                         previously no connection was present.
  74
  75                 string Policy [readwrite]
  76
  77                         The global connection policy of a system. This
  78                         allows to configure how connections are established
  79                         and also when they are taken down again.
  80
  81                         Possible values are "single", "multiple" and "ask".
  82
  83                         For the single policy, the priority setting of the
  84                         device defines which becomes the default connection
  85                         when multiple are available.
  86
  87                 boolean OfflineMode [readwrite]
  88
  89                         The offline mode indicates the global setting for
  90                         switching all radios on or off. Changing offline mode
  91                         to true results in powering down all devices. When
  92                         leaving offline mode the individual policy of each
  93                         device decides to switch the radio back on or not.
  94
  95                         During offline mode, it is still possible to switch
  96                         certain technologies manually back on. For example
  97                         the limited usage of WiFi or Bluetooth devices might
  98                         be allowed in some situations.
  99
 100                 object ActiveProfile [readwrite]
 101
 102                         Object path of the current active profile.
 103
 104                 array{object} Profiles [readonly]
 105
 106                         List of profile object paths.
 107
 108                 array{object} Devices [readonly]
 109
 110                         List of device object paths.
 111
 112                 array{object} Services [readonly]
 113
 114                         List of service object paths. The list is sorted
 115                         internally to have the service with the default
 116                         route always first and then the favorite services
 117                         followed by scan results.
 118
 119                         This list represents the available services for the
 120                         current selected profile. If the profile gets changed
 121                         then this list will be updated.
 122
 123                         The same list is available via the profile object
 124                         itself. It is just provided here for convenience of
 125                         applications only dealing with the current active
 126                         profile.
 127
 128                 array{object} Connections [readonly]
 129
 130                         List of active connection object paths.