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

Dan Williams's avatar
Dan Williams committed
3
<node name="/org/freedesktop/NetworkManager/Settings" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4
  <interface name="org.freedesktop.NetworkManager.Settings">
Dan Williams's avatar
Dan Williams committed
5
    <tp:docstring>
6
      The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.
Dan Williams's avatar
Dan Williams committed
7 8 9 10
    </tp:docstring>

    <method name="ListConnections">
      <tp:docstring>
11
        List the saved network connections known to NetworkManager.
Dan Williams's avatar
Dan Williams committed
12 13 14
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_list_connections"/>
      <arg name="connections" type="ao" direction="out">
15
        <tp:docstring>
Dan Williams's avatar
Dan Williams committed
16
          List of connections.
17
        </tp:docstring>
Dan Williams's avatar
Dan Williams committed
18 19
      </arg>
    </method>
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
    <method name="GetConnectionByUuid">
      <tp:docstring>
        Retrieve the object path of a connection, given that connection's UUID.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_get_connection_by_uuid"/>
      <arg name="uuid" type="s" direction="in">
        <tp:docstring>
          The UUID to find the connection object path for.
        </tp:docstring>
      </arg>
      <arg name="connection" type="o" direction="out">
        <tp:docstring>
          The connection's object path.
        </tp:docstring>
      </arg>
    </method>

38 39
    <method name="AddConnection">
      <tp:docstring>
40 41 42 43
        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.
44 45 46 47 48 49 50 51
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_add_connection"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="connection" type="a{sa{sv}}" direction="in">
        <tp:docstring>
          Connection settings and properties.
        </tp:docstring>
      </arg>
52 53 54 55
      <arg name="path" type="o" direction="out">
        <tp:docstring>
          Object path of the new connection that was just added.
        </tp:docstring>
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
      </arg>
    </method>

    <method name="AddConnectionUnsaved">
      <tp:docstring>
        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.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_add_connection_unsaved"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="connection" type="a{sa{sv}}" direction="in">
        <tp:docstring>
          Connection settings and properties.
        </tp:docstring>
      </arg>
      <arg name="path" type="o" direction="out">
        <tp:docstring>
          Object path of the new connection that was just added.
        </tp:docstring>
77
      </arg>
78 79
    </method>

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
    <method name="SaveHostname">
      <tp:docstring>
        Save the hostname to persistent configuration.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_save_hostname"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="hostname" type="s" direction="in">
        <tp:docstring>
          The hostname to save to persistent configuration.  If blank, the persistent hostname is cleared.
        </tp:docstring>
      </arg>
    </method>

    <property name="Hostname" type="s" access="read">
      <tp:docstring>
        The machine hostname stored in persistent configuration.
      </tp:docstring>
    </property>

    <property name="CanModify" type="b" access="read">
      <tp:docstring>
        If true, adding and modifying connections is supported.
      </tp:docstring>
    </property>

    <signal name="PropertiesChanged">
        <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
            <tp:docstring>
                A dictionary mapping property names to variant boxed values
            </tp:docstring>
        </arg>
    </signal>

Dan Williams's avatar
Dan Williams committed
113 114
    <signal name="NewConnection">
      <tp:docstring>
115 116 117 118 119 120 121 122
        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.
Dan Williams's avatar
Dan Williams committed
123 124 125 126 127 128 129
      </tp:docstring>
      <arg name="connection" type="o">
        <tp:docstring>
          Object path of the new connection.
        </tp:docstring>
      </arg>
    </signal>
Dan Williams's avatar
Dan Williams committed
130

Dan Williams's avatar
Dan Williams committed
131
  </interface>
132
</node>
Dan Williams's avatar
Dan Williams committed
133