git.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                 void RegisterAgent(object path)
  26
  27                         Register new agent for handling user requests.
  28
  29                         Possible Errors: [service].Error.InvalidArguments
  30
  31                 void UnregisterAgent(object path)
  32
  33                         Unregister an existing agent.
  34
  35                         Possible Errors: [service].Error.InvalidArguments
  36
  37 Signals         PropertyChanged(string name, variant value)
  38
  39                         This signal indicates a changed value of the given
  40                         property.
  41
  42 Properties      string State [readonly]
  43
  44                         The global connection state of a system. Possible
  45                         values are "online" if at least one connection exists
  46                         and "offline" if no device is connected.
  47
  48                         In certain situations the state might change to
  49                         the value "connected". This can only be seen if
  50                         previously no connection was present.
  51
  52                 string Policy [readwrite]
  53
  54                         The global connection policy of a system. This
  55                         allows to configure how connections are established
  56                         and also when they are taken down again.
  57
  58                         Possible values are "single", "multiple" and "ask".
  59
  60                         For the single policy, the priority setting of the
  61                         device defines which becomes the default connection
  62                         when multiple are available.
  63
  64                 boolean OfflineMode [readwrite]
  65
  66                         The offline mode indicates the global setting for
  67                         switching all radios on or off. Changing offline mode
  68                         to true results in powering down all devices. When
  69                         leaving offline mode the individual policy of each
  70                         device decides to switch the radio back on or not.
  71
  72                         During offline mode, it is still possible to switch
  73                         certain technologies manually back on. For example
  74                         the limited usage of WiFi or Bluetooth devices might
  75                         be allowed in some situations.
  76
  77                 array{object} Profiles [readonly]
  78
  79                         List of profile object paths.
  80
  81                 array{object} Devices [readonly]
  82
  83                         List of device object paths.
  84
  85                 array{object} Connections [readonly]
  86
  87                         List of active connection object paths.