nm-settings-connection.xml 5.53 KB
Newer Older
1 2
<?xml version="1.0" encoding="UTF-8" ?>

3
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4

5
    <interface name="org.freedesktop.NetworkManager.Settings.Connection">
6 7 8
        <tp:docstring>
            Represents a single network connection configuration.
        </tp:docstring>
9 10 11

        <method name="Update">
          <tp:docstring>
12 13 14 15 16
            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.
17
          </tp:docstring>
18
          <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_connection_update"/>
19 20
          <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
          <arg name="properties" type="a{sa{sv}}" direction="in">
21
            <tp:docstring>
22
              New connection settings, properties, and (optionally) secrets.
23
            </tp:docstring>
24
          </arg>
25
        </method>
26

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
        <method name="UpdateUnsaved">
          <tp:docstring>
            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 the
            flags associated with each secret.
          </tp:docstring>
          <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_connection_update_unsaved"/>
          <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
          <arg name="properties" type="a{sa{sv}}" direction="in">
            <tp:docstring>
              New connection settings, properties, and (optionally) secrets.
            </tp:docstring>
          </arg>
        </method>

44 45 46 47
        <method name="Delete">
          <tp:docstring>
            Delete the connection.
          </tp:docstring>
48
          <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_connection_delete"/>
49
          <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
50
        </method>
51

52 53
        <method name="GetSettings">
            <tp:docstring>
54 55 56 57
                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.
58
            </tp:docstring>
59
            <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_connection_get_settings"/>
Dan Williams's avatar
Dan Williams committed
60
            <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
61 62 63 64 65 66
            <arg name="settings" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map">
                <tp:docstring>
                    The nested settings maps describing this object.
                </tp:docstring>
            </arg>
        </method>
67

68 69
        <method name="GetSecrets">
            <tp:docstring>
70 71 72 73
                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.
74
            </tp:docstring>
75
            <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_connection_get_secrets"/>
76 77 78
            <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
            <arg name="setting_name" type="s" direction="in">
                <tp:docstring>
79 80
                    Name of the setting to return secrets for.  If empty, all
                    all secrets will be returned.
81 82
                </tp:docstring>
            </arg>
83

84
            <arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map">
85
                <tp:docstring>
86
                    Nested settings maps containing secrets.
87 88 89
                </tp:docstring>
            </arg>
        </method>
90

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
        <signal name="Updated">
            <tp:docstring>
                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.
            </tp:docstring>
        </signal>

        <signal name="Removed">
            <tp:docstring>
                Emitted when this connection is no longer available.  This
                happens when the connection is deleted or if it is no longer
                accessable by any of the system's logged-in users.  After
                receipt of this signal, the object no longer exists.
            </tp:docstring>
        </signal>

109 110 111 112 113 114 115 116 117 118
        <property name="Unsaved" type="b" access="read">
            <tp:docstring>
                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.
            </tp:docstring>
        </property>

119
    </interface>
120 121

</node>