summaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.NetworkManager.Settings.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.xml
parent0ce7da1e22abf7a4415ef40fca9f1755b8ddfa30 (diff)
downloadNetworkManager-972e0d28031d4837fbb7d07dce0a7354e5c1a975.tar.gz
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.xml')
-rw-r--r--introspection/org.freedesktop.NetworkManager.Settings.xml172
1 files changed, 172 insertions, 0 deletions
diff --git a/introspection/org.freedesktop.NetworkManager.Settings.xml b/introspection/org.freedesktop.NetworkManager.Settings.xml
new file mode 100644
index 0000000000..32675e02d8
--- /dev/null
+++ b/introspection/org.freedesktop.NetworkManager.Settings.xml
@@ -0,0 +1,172 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<node name="/org/freedesktop/NetworkManager/Settings">
+
+ <!--
+ org.freedesktop.NetworkManager.Settings:
+
+ The Settings interface allows clients to view and administrate the
+ connections stored and used by NetworkManager.
+ -->
+ <interface name="org.freedesktop.NetworkManager.Settings">
+
+ <!--
+ ListConnections:
+ @connections: List of connections.
+
+ List the saved network connections known to NetworkManager.
+ -->
+ <method name="ListConnections">
+ <arg name="connections" type="ao" direction="out"/>
+ </method>
+
+ <!--
+ GetConnectionByUuid:
+ @uuid: The UUID to find the connection object path for.
+ @connection: The connection's object path.
+
+ Retrieve the object path of a connection, given that connection's UUID.
+ -->
+ <method name="GetConnectionByUuid">
+ <arg name="uuid" type="s" direction="in"/>
+ <arg name="connection" type="o" direction="out"/>
+ </method>
+
+ <!--
+ AddConnection:
+ @connection: Connection settings and properties.
+ @path: Object path of the new connection that was just added.
+
+ Add new connection and save it to disk. This operation does not start the
+ network connection unless (1) device is idle and able to connect to the
+ network described by the new connection, and (2) the connection is allowed
+ to be started automatically.
+ -->
+ <method name="AddConnection">
+ <arg name="connection" type="a{sa{sv}}" direction="in"/>
+ <arg name="path" type="o" direction="out"/>
+ </method>
+
+ <!--
+ AddConnectionUnsaved:
+ @connection: Connection settings and properties.
+ @path: Object path of the new connection that was just added.
+
+ Add new connection but do not save it to disk immediately. This operation
+ does not start the network connection unless (1) device is idle and able
+ to connect to the network described by the new connection, and (2) the
+ connection is allowed to be started automatically. Use the 'Save' method
+ on the connection 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="AddConnectionUnsaved">
+ <arg name="connection" type="a{sa{sv}}" direction="in"/>
+ <arg name="path" type="o" direction="out"/>
+ </method>
+
+ <!--
+ LoadConnections:
+ @filenames: Array of paths to on-disk connection profiles in directories monitored by NetworkManager.
+ @status: Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).
+ @failures: Paths of connection files that could not be loaded.
+
+ Loads or reloads the indicated connections from disk. You should call this
+ after making changes directly to an on-disk connection file to make sure
+ that NetworkManager sees the changes. (If "monitor-connection-files" in
+ NetworkManager.conf is "true", then this will have no real effect, but is
+ harmless.) As with AddConnection(), this operation does not necessarily
+ start the network connection.
+ -->
+ <method name="LoadConnections">
+ <arg name="filenames" type="as" direction="in"/>
+ <arg name="status" type="b" direction="out"/>
+ <arg name="failures" type="as" direction="out"/>
+ </method>
+
+ <!--
+ ReloadConnections:
+ @status: Success or failure.
+
+ Tells NetworkManager to reload all connection files from disk, including
+ noticing any added or deleted connection files. By default, connections
+ are re-read automatically any time they change, so you only need to use
+ this command if you have set "monitor-connection-files=false" in
+ NetworkManager.conf.
+ -->
+ <method name="ReloadConnections">
+ <arg name="status" type="b" direction="out"/>
+ </method>
+
+ <!--
+ SaveHostname:
+ @hostname: The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.
+
+ Save the hostname to persistent configuration.
+ -->
+ <method name="SaveHostname">
+ <arg name="hostname" type="s" direction="in"/>
+ </method>
+
+ <!--
+ Connections:
+
+ List of object paths of available network connection profiles.
+ -->
+ <property name="Connections" type="ao" access="read"/>
+
+ <!--
+ Hostname:
+
+ The machine hostname stored in persistent configuration.
+ -->
+ <property name="Hostname" type="s" access="read"/>
+
+ <!--
+ CanModify:
+
+ If true, adding and modifying connections is supported.
+ -->
+ <property name="CanModify" 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>
+
+ <!--
+ NewConnection:
+ @connection: Object path of the new connection.
+
+ Emitted when a new connection has been added after NetworkManager has
+ started up and initialized. This signal is not emitted for connections
+ read while starting up, because NetworkManager's D-Bus service is only
+ available after all connections have been read, and to prevent spamming
+ listeners with too many signals at one time. To retrieve the initial
+ connection list, call the ListConnections() method once, and then listen
+ for individual Settings.NewConnection and Settings.Connection.Deleted
+ signals for further updates.
+ -->
+ <signal name="NewConnection">
+ <arg name="connection" type="o"/>
+ </signal>
+
+ <!--
+ ConnectionRemoved:
+ @connection: Object path of the removed connection.
+
+ Emitted when a 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 connection no
+ longer exists and cannot be used. Also see the Settings.Connection.Removed
+ signal.
+ -->
+ <signal name="ConnectionRemoved">
+ <arg name="connection" type="o"/>
+ </signal>
+ </interface>
+</node>