summaryrefslogtreecommitdiff
path: root/doc/vpn-manager-api.txt
blob: 66c5beeff0d30102c0ec336da8bc44f273c8cf5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
vpn manager
===========

Service		net.connman.vpn
Interface	net.connman.vpn.Manager
Object path	/

Method		object Create(dict settings) [experimental]

			Create a new VPN connection and configuration using
			the supplied settings.

		void Remove(object vpn)  [experimental]

			Remove the previously created VPN configuration.

		array{object,dict} GetConnections()  [experimental]

			Returns a list of tuples with VPN connection object
			path and dictionary of their properties.

			Possible Errors: [manager].Error.InvalidArguments

		void RegisterAgent(object path)  [experimental]

			Register new agent for handling user requests.

			Possible Errors: [manager].Error.InvalidArguments

		void UnregisterAgent(object path)  [experimental]

			Unregister an existing agent.

			Possible Errors: [manager].Error.InvalidArguments

Signals		ConnectionAdded(object path, dict properties)  [experimental]

			Signal that is sent when a new VPN connection
			is added.

			It contains the object path of the VPN connection
			and also its properties.

		ConnectionRemoved(object path)  [experimental]

			Signal that is sent when a VPN connection
			has been removed.

			The object path is no longer accessible after this
			signal and only emitted for reference.