mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-10-06 16:21:50 +00:00
618373a14f
gdbus only understands those (and gtk docstrings, which we should eventually use) when generating the documentation.
199 lines
8 KiB
XML
199 lines
8 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
|
|
<node name="/org/freedesktop/NetworkManager/Settings" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
|
|
<interface name="org.freedesktop.NetworkManager.Settings">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.
|
|
" />
|
|
|
|
<method name="ListConnections">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
List the saved network connections known to NetworkManager.
|
|
" />
|
|
<arg name="connections" type="ao" direction="out">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
List of connections.
|
|
" />
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="GetConnectionByUuid">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Retrieve the object path of a connection, given that connection's UUID.
|
|
" />
|
|
<arg name="uuid" type="s" direction="in">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
The UUID to find the connection object path for.
|
|
" />
|
|
</arg>
|
|
<arg name="connection" type="o" direction="out">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
The connection's object path.
|
|
" />
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="AddConnection">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
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.
|
|
" />
|
|
<arg name="connection" type="a{sa{sv}}" direction="in">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Connection settings and properties.
|
|
" />
|
|
</arg>
|
|
<arg name="path" type="o" direction="out">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Object path of the new connection that was just added.
|
|
" />
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="AddConnectionUnsaved">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
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).
|
|
" />
|
|
<arg name="connection" type="a{sa{sv}}" direction="in">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Connection settings and properties.
|
|
" />
|
|
</arg>
|
|
<arg name="path" type="o" direction="out">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Object path of the new connection that was just added.
|
|
" />
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="LoadConnections">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
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.
|
|
" />
|
|
<arg name="filenames" type="as" direction="in">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Array of paths to on-disk connection profiles in directories
|
|
monitored by NetworkManager.
|
|
" />
|
|
</arg>
|
|
<arg name="status" type="b" direction="out">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
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).
|
|
" />
|
|
</arg>
|
|
<arg name="failures" type="as" direction="out">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Paths of connection files that could not be loaded.
|
|
" />
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="ReloadConnections">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
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.
|
|
" />
|
|
<arg name="status" type="b" direction="out">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Success or failure.
|
|
" />
|
|
</arg>
|
|
</method>
|
|
|
|
<method name="SaveHostname">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Save the hostname to persistent configuration.
|
|
" />
|
|
<arg name="hostname" type="s" direction="in">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.
|
|
" />
|
|
</arg>
|
|
</method>
|
|
|
|
<property name="Connections" type="ao" access="read">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
List of object paths of available network connection profiles.
|
|
" />
|
|
</property>
|
|
|
|
<property name="Hostname" type="s" access="read">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
The machine hostname stored in persistent configuration.
|
|
" />
|
|
</property>
|
|
|
|
<property name="CanModify" type="b" access="read">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
If true, adding and modifying connections is supported.
|
|
" />
|
|
</property>
|
|
|
|
<signal name="PropertiesChanged">
|
|
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
A dictionary mapping property names to variant boxed values
|
|
" />
|
|
</arg>
|
|
</signal>
|
|
|
|
<signal name="NewConnection">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
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.
|
|
" />
|
|
<arg name="connection" type="o">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Object path of the new connection.
|
|
" />
|
|
</arg>
|
|
</signal>
|
|
|
|
<signal name="ConnectionRemoved">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
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.
|
|
" />
|
|
<arg name="connection" type="o">
|
|
<annotation name="org.gtk.GDBus.DocString" value="
|
|
Object path of the removed connection.
|
|
" />
|
|
</arg>
|
|
</signal>
|
|
|
|
</interface>
|
|
</node>
|
|
|