Commit b62a3abb authored by Dan Williams's avatar Dan Williams

api: update Settings documentation to explain NewConnection signal timing (bgo #697742)

parent 6701181c
......@@ -8,7 +8,7 @@
<method name="ListConnections">
<tp:docstring>
List the connections stored by this Settings object.
List the saved network connections known to NetworkManager.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_list_connections"/>
<arg name="connections" type="ao" direction="out">
......@@ -37,7 +37,10 @@
<method name="AddConnection">
<tp:docstring>
Add new connection.
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.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_add_connection"/>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
......@@ -88,7 +91,14 @@
<signal name="NewConnection">
<tp:docstring>
Emitted when a new connection has been added.
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.
</tp:docstring>
<arg name="connection" type="o">
<tp:docstring>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment