introspection/nm-settings-connection.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   4
   5     <interface name="org.freedesktop.NetworkManager.Settings.Connection">
   6         <tp:docstring>
   7             Represents a single network connection configuration.
   8         </tp:docstring>
   9
  10         <method name="Update">
  11           <tp:docstring>
  12             Update the connection with new settings and properties (replacing
  13             all previous settings and properties) and save the connection to
  14             disk.  Secrets may be part of the update request, and will be either
  15             stored in persistent storage or sent to a Secret Agent for storage,
  16             depending on the flags associated with each secret.
  17           </tp:docstring>
  18           <arg name="properties" type="a{sa{sv}}" direction="in">
  19             <tp:docstring>
  20               New connection settings, properties, and (optionally) secrets.
  21             </tp:docstring>
  22           </arg>
  23         </method>
  24
  25         <method name="UpdateUnsaved">
  26           <tp:docstring>
  27             Update the connection with new settings and properties (replacing
  28             all previous settings and properties) but do not immediately save
  29             the connection to disk.  Secrets may be part of the update request
  30             and may sent to a Secret Agent for storage, depending on the
  31             flags associated with each secret.
  32
  33             Use the 'Save' method to save these changes to disk. Note
  34             that unsaved changes will be lost if the connection is
  35             reloaded from disk (either automatically on file change or
  36             due to an explicit ReloadConnections call).
  37           </tp:docstring>
  38           <arg name="properties" type="a{sa{sv}}" direction="in">
  39             <tp:docstring>
  40               New connection settings, properties, and (optionally) secrets.
  41             </tp:docstring>
  42           </arg>
  43         </method>
  44
  45         <method name="Delete">
  46           <tp:docstring>
  47             Delete the connection.
  48           </tp:docstring>
  49         </method>
  50
  51         <method name="GetSettings">
  52             <tp:docstring>
  53                 Get the settings maps describing this network configuration.
  54                 This will never include any secrets required for connection
  55                 to the network, as those are often protected.  Secrets must
  56                 be requested separately using the GetSecrets() call.
  57             </tp:docstring>
  58             <arg name="settings" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map">
  59                 <tp:docstring>
  60                     The nested settings maps describing this object.
  61                 </tp:docstring>
  62             </arg>
  63         </method>
  64
  65         <method name="GetSecrets">
  66             <tp:docstring>
  67                 Get the secrets belonging to this network configuration.  Only
  68                 secrets from persistent storage or a Secret Agent running in
  69                 the requestor's session will be returned.  The user will never
  70                 be prompted for secrets as a result of this request.
  71             </tp:docstring>
  72             <arg name="setting_name" type="s" direction="in">
  73                 <tp:docstring>
  74                     Name of the setting to return secrets for.  If empty, all
  75                     all secrets will be returned.
  76                 </tp:docstring>
  77             </arg>
  78
  79             <arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map">
  80                 <tp:docstring>
  81                     Nested settings maps containing secrets.
  82                 </tp:docstring>
  83             </arg>
  84         </method>
  85
  86         <method name="ClearSecrets">
  87           <tp:docstring>
  88             Clear the secrets belonging to this network connection profile.
  89           </tp:docstring>
  90         </method>
  91
  92         <method name="Save">
  93             <tp:docstring>
  94                 Saves a "dirty" connection (that had previously been
  95                 updated with UpdateUnsaved) to persistent storage.
  96             </tp:docstring>
  97         </method>
  98
  99         <signal name="Updated">
 100             <tp:docstring>
 101                 Emitted when any settings or permissions change.  When handling
 102                 this signal, clients should re-read the connection using the
 103                 GetSettings method to get the changes and to ensure the client
 104                 still has permission to access the connection.
 105             </tp:docstring>
 106         </signal>
 107
 108         <signal name="Removed">
 109             <tp:docstring>
 110                 Emitted when this connection is no longer available.  This
 111                 happens when the connection is deleted or if it is no longer
 112                 accessible by any of the system's logged-in users.  After
 113                 receipt of this signal, the object no longer exists.  Also
 114                 see the Settings.ConnectionRemoved signal.
 115             </tp:docstring>
 116         </signal>
 117
 118         <property name="Unsaved" type="b" access="read">
 119             <tp:docstring>
 120                 If set, indicates that the in-memory state of the
 121                 connection does not match the on-disk state. This flag
 122                 will be set when UpdateUnsaved() is called or when any
 123                 connection details change, and cleared when the connection
 124                 is saved to disk via Save() or from internal operations.
 125             </tp:docstring>
 126         </property>
 127
 128         <signal name="PropertiesChanged">
 129             <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
 130                 <tp:docstring>
 131                     A dictionary mapping property names to variant boxed values.
 132                 </tp:docstring>
 133             </arg>
 134         </signal>
 135
 136     </interface>
 137
 138 </node>