diff options
Diffstat (limited to 'doc/vpn-connection-api.txt')
| -rw-r--r-- | doc/vpn-connection-api.txt | 48 |
1 files changed, 43 insertions, 5 deletions
diff --git a/doc/vpn-connection-api.txt b/doc/vpn-connection-api.txt index 1fd3be26..ec557889 100644 --- a/doc/vpn-connection-api.txt +++ b/doc/vpn-connection-api.txt @@ -14,13 +14,48 @@ Methods dict GetProperties() [experimental] void SetProperty(string name, variant value) [experimental] - Changes the value of the specified property. Only - properties that are listed as read-write are - changeable. On success a PropertyChanged signal - will be emitted. + Changes the value of the specified property or the + properties defined as a dict passed as variant, where + the format is equal to the dict returned by + GetProperties(). Only properties that are listed as + read-write are changeable. Property name "Properties" + indicates a dict of properties. On success a + PropertyChanged signal will be emitted for the + specified property or for all changed properties + individually. If there is no change in property value + no PropertyChanged signal is sent. Configuration is + written to disk when one or more values are changed. + In case a dict of properties are given, configuration + write is done after all properties are processed. + Specifics in dict use in contrast to setting a single + property: + - Dict can contain values set as empty strings + or arrays. This causes the values to be + cleared as if using ClearProperty(). + - If there are errors with the properties, + InvalidProperty or PermissionDenied error is + returned. InvalidProperty is sent when there + is at least one invalid property, in this + case there can be also properties that + cannot be changed (immutable properties). + If there are only immutable properties + PermissionDenied error is returned. + - The properties that are invalid or immutable + are reported back at the end of the error + message as a comma separated property name + list. + - One invalid/immutable property does not + cause the rest of the properties to be + ignored. If there are valid and invalid + properties, the valid properties emit + PropertyChanged signal and invalid are + reported back with an InvalidProperty + message. Possible Errors: [connection].Error.InvalidArguments [connection].Error.InvalidProperty + [connection].Error.PermissionDenied + [connection].Error.NotSupported void ClearProperty(string name) [experimental] @@ -28,6 +63,7 @@ Methods dict GetProperties() [experimental] Possible Errors: [connection].Error.InvalidArguments [connection].Error.InvalidProperty + [connection].Error.PermissionDenied void Connect() [experimental] @@ -149,7 +185,9 @@ Properties string State [readonly] int ProtocolFamily Protocol family of the route. Set to 4 - if IPv4 and 6 if IPv6 route. + if IPv4 and 6 if IPv6 route. Set to 0 + (PF_UNSPEC) or omit, to have it assigned + automatically. string Network |