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 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                 StateChanged(string state)
  66
  67                         This signal is similar to the PropertyChanged signal
  68                         for the State property.
  69
  70                         It exists for application state only care about the
  71                         current state and so can avoid to be woken up when
  72                         other details changes.
  73
  74 Properties      string State [readonly]
  75
  76                         The global connection state of a system. Possible
  77                         values are "online" if at least one connection exists
  78                         and "offline" if no device is connected.
  79
  80                         In certain situations the state might change to
  81                         the value "connected". This can only be seen if
  82                         previously no connection was present.
  83
  84                 boolean OfflineMode [readwrite]
  85
  86                         The offline mode indicates the global setting for
  87                         switching all radios on or off. Changing offline mode
  88                         to true results in powering down all devices. When
  89                         leaving offline mode the individual policy of each
  90                         device decides to switch the radio back on or not.
  91
  92                         During offline mode, it is still possible to switch
  93                         certain technologies manually back on. For example
  94                         the limited usage of WiFi or Bluetooth devices might
  95                         be allowed in some situations.
  96
  97                 object ActiveProfile [readwrite]
  98
  99                         Object path of the current active profile.
 100
 101                 array{object} Profiles [readonly]
 102
 103                         List of profile object paths.
 104
 105                 array{object} Devices [readonly]
 106
 107                         List of device object paths.
 108
 109                 array{object} Services [readonly]
 110
 111                         List of service object paths. The list is sorted
 112                         internally to have the service with the default
 113                         route always first and then the favorite services
 114                         followed by scan results.
 115
 116                         This list represents the available services for the
 117                         current selected profile. If the profile gets changed
 118                         then this list will be updated.
 119
 120                         The same list is available via the profile object
 121                         itself. It is just provided here for convenience of
 122                         applications only dealing with the current active
 123                         profile.
 124
 125                 array{object} Connections [readonly]
 126
 127                         List of active connection object paths.