diff options
Diffstat (limited to 'introspection/nm-settings-connection.xml')
| -rw-r--r-- | introspection/nm-settings-connection.xml | 267 |
1 files changed, 130 insertions, 137 deletions
diff --git a/introspection/nm-settings-connection.xml b/introspection/nm-settings-connection.xml index fc62046c..15b38034 100644 --- a/introspection/nm-settings-connection.xml +++ b/introspection/nm-settings-connection.xml @@ -1,138 +1,131 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - - <interface name="org.freedesktop.NetworkManager.Settings.Connection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Represents a single network connection configuration. - " /> - - <method name="Update"> - <annotation name="org.gtk.GDBus.DocString" value=" - 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. - " /> - <arg name="properties" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - New connection settings, properties, and (optionally) secrets. - " /> - </arg> - </method> - - <method name="UpdateUnsaved"> - <annotation name="org.gtk.GDBus.DocString" value=" - 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). - " /> - <arg name="properties" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - New connection settings, properties, and (optionally) secrets. - " /> - </arg> - </method> - - <method name="Delete"> - <annotation name="org.gtk.GDBus.DocString" value=" - Delete the connection. - " /> - </method> - - <method name="GetSettings"> - <annotation name="org.gtk.GDBus.DocString" value=" - 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. - " /> - <arg name="settings" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The nested settings maps describing this object. - " /> - </arg> - </method> - - <method name="GetSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - 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. - " /> - <arg name="setting_name" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Name of the setting to return secrets for. If empty, all - all secrets will be returned. - " /> - </arg> - - <arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Nested settings maps containing secrets. - " /> - </arg> - </method> - - <method name="ClearSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Clear the secrets belonging to this network connection profile. - " /> - </method> - - <method name="Save"> - <annotation name="org.gtk.GDBus.DocString" value=" - Saves a "dirty" connection (that had previously been - updated with UpdateUnsaved) to persistent storage. - " /> - </method> - - <signal name="Updated"> - <annotation name="org.gtk.GDBus.DocString" value=" - 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> - - <signal name="Removed"> - <annotation name="org.gtk.GDBus.DocString" value=" - 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> - - <property name="Unsaved" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - 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> - - <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> - - </interface> - +<?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. + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> + </interface> </node> |