doc/vpn-manager-api.txt

   1 vpn manager
   2 ===========
   3
   4 Service         net.connman.vpn
   5 Interface       net.connman.vpn.Manager
   6 Object path     /
   7
   8 Method          object Create(dict settings) [experimental]
   9
  10                         Create a new VPN connection and configuration using
  11                         the supplied settings.
  12
  13                 void Remove(object vpn)  [experimental]
  14
  15                         Remove the previously created VPN configuration.
  16
  17                 array{object,dict} GetConnections()  [experimental]
  18
  19                         Returns a list of tuples with VPN connection object
  20                         path and dictionary of their properties.
  21
  22                         Possible Errors: [manager].Error.InvalidArguments
  23
  24                 void RegisterAgent(object path)  [experimental]
  25
  26                         Register new agent for handling user requests.
  27
  28                         Possible Errors: [manager].Error.InvalidArguments
  29
  30                 void UnregisterAgent(object path)  [experimental]
  31
  32                         Unregister an existing agent.
  33
  34                         Possible Errors: [manager].Error.InvalidArguments
  35
  36 Signals         ConnectionAdded(object path, dict properties)  [experimental]
  37
  38                         Signal that is sent when a new VPN connection
  39                         is added.
  40
  41                         It contains the object path of the VPN connection
  42                         and also its properties.
  43
  44                 ConnectionRemoved(object path)  [experimental]
  45
  46                         Signal that is sent when a VPN connection
  47                         has been removed.
  48
  49                         The object path is no longer accessible after this
  50                         signal and only emitted for reference.