summaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.NetworkManager.Settings.Connection.xml
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2016-11-23 13:14:08 +0100
committerLubomir Rintel <lkundrak@v3.sk>2016-11-23 15:43:42 +0100
commit972e0d28031d4837fbb7d07dce0a7354e5c1a975 (patch)
treeaa8b64b71a9925af7457b78713787553c9426208 /introspection/org.freedesktop.NetworkManager.Settings.Connection.xml
parent0ce7da1e22abf7a4415ef40fca9f1755b8ddfa30 (diff)
all: rename the introspection data to use the interface paths in names
This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
Diffstat (limited to 'introspection/org.freedesktop.NetworkManager.Settings.Connection.xml')
-rw-r--r--introspection/org.freedesktop.NetworkManager.Settings.Connection.xml133
1 files changed, 133 insertions, 0 deletions
diff --git a/introspection/org.freedesktop.NetworkManager.Settings.Connection.xml b/introspection/org.freedesktop.NetworkManager.Settings.Connection.xml
new file mode 100644
index 000000000..cf33120ce
--- /dev/null
+++ b/introspection/org.freedesktop.NetworkManager.Settings.Connection.xml
@@ -0,0 +1,133 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<node name="/">
+
+ <!--
+ org.freedesktop.NetworkManager.Settings.Connection:
+
+ Represents a single network connection configuration.
+ -->
+ <interface name="org.freedesktop.NetworkManager.Settings.Connection">
+
+ <!--
+ Update:
+ @properties: New connection settings, properties, and (optionally) secrets.
+
+ Update the connection with new settings and properties (replacing all
+ previous settings and properties) and save the connection to disk. Secrets
+ may be part of the update request, and will be either stored in persistent
+ storage or sent to a Secret Agent for storage, depending on the flags
+ associated with each secret.
+ -->
+ <method name="Update">
+ <arg name="properties" type="a{sa{sv}}" direction="in"/>
+ </method>
+
+ <!--
+ UpdateUnsaved:
+ @properties: New connection settings, properties, and (optionally) secrets.
+
+ Update the connection with new settings and properties (replacing all
+ previous settings and properties) but do not immediately save the
+ connection to disk. Secrets may be part of the update request and may sent
+ to a Secret Agent for storage, depending on the flags associated with each
+ secret. Use the 'Save' method to save these changes to disk. Note that
+ unsaved changes will be lost if the connection is reloaded from disk
+ (either automatically on file change or due to an explicit
+ ReloadConnections call).
+ -->
+ <method name="UpdateUnsaved">
+ <arg name="properties" type="a{sa{sv}}" direction="in"/>
+ </method>
+
+ <!--
+ Delete:
+
+ Delete the connection.
+ -->
+ <method name="Delete"/>
+
+ <!--
+ GetSettings:
+ @settings: The nested settings maps describing this object.
+
+ Get the settings maps describing this network configuration. This will
+ never include any secrets required for connection to the network, as those
+ are often protected. Secrets must be requested separately using the
+ GetSecrets() call.
+ -->
+ <method name="GetSettings">
+ <arg name="settings" type="a{sa{sv}}" direction="out"/>
+ </method>
+
+ <!--
+ GetSecrets:
+ @setting_name: Name of the setting to return secrets for. If empty, all all secrets will be returned.
+ @secrets: Nested settings maps containing secrets.
+
+ Get the secrets belonging to this network configuration. Only secrets from
+ persistent storage or a Secret Agent running in the requestor's session
+ will be returned. The user will never be prompted for secrets as a result
+ of this request.
+ -->
+ <method name="GetSecrets">
+ <arg name="setting_name" type="s" direction="in"/>
+
+ <arg name="secrets" type="a{sa{sv}}" direction="out"/>
+ </method>
+
+ <!--
+ ClearSecrets:
+
+ Clear the secrets belonging to this network connection profile.
+ -->
+ <method name="ClearSecrets"/>
+
+ <!--
+ Save:
+
+ Saves a "dirty" connection (that had previously been updated with
+ UpdateUnsaved) to persistent storage.
+ -->
+ <method name="Save"/>
+
+ <!--
+ Updated:
+
+ Emitted when any settings or permissions change. When handling this
+ signal, clients should re-read the connection using the GetSettings method
+ to get the changes and to ensure the client still has permission to access
+ the connection.
+ -->
+ <signal name="Updated"/>
+
+ <!--
+ Removed:
+
+ Emitted when this connection is no longer available. This happens when the
+ connection is deleted or if it is no longer accessible by any of the
+ system's logged-in users. After receipt of this signal, the object no
+ longer exists. Also see the Settings.ConnectionRemoved signal.
+ -->
+ <signal name="Removed"/>
+
+ <!--
+ Unsaved:
+
+ If set, indicates that the in-memory state of the connection does not
+ match the on-disk state. This flag will be set when UpdateUnsaved() is
+ called or when any connection details change, and cleared when the
+ connection is saved to disk via Save() or from internal operations.
+ -->
+ <property name="Unsaved" type="b" access="read"/>
+
+ <!--
+ PropertiesChanged:
+ @properties: A dictionary mapping property names to variant boxed values.
+
+ DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
+ -->
+ <signal name="PropertiesChanged">
+ <arg name="properties" type="a{sv}"/>
+ </signal>
+ </interface>
+</node>