nm-settings.xml 4.39 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">
Dan Williams's avatar
Dan Williams committed
4 5 6 7 8 9 10 11 12 13 14
  <interface name="org.freedesktop.NetworkManagerSettings">
    <tp:docstring>
      The NetworkManagerSettings interface is provided by the service which provides connections to NetworkManager.
    </tp:docstring>

    <method name="ListConnections">
      <tp:docstring>
        List the connections stored by this Settings object.
      </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
    <method name="AddConnection">
      <tp:docstring>
        Add new connection.
      </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>
    </method>

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
    <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>

    <method name="GetPermissions">
      <tp:docstring>
        Returns a bitfield indicating certain operations the caller is permitted to perform.  Some of these operations may require authorization by the user.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_settings_get_permissions"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="permissions" type="u" direction="out" tp:type="NM_SETTINGS_PERMISSIONS">
        <tp:docstring>
          A bitfield of permitted operations.  Some of these operations may require the user to authorize via password entry or other means.
        </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>

    <signal name="CheckPermissions">
      <tp:docstring>
        Emitted when system authorization details change, indicating that clients may wish to recheck permissions with GetPermissions.
      </tp:docstring>
    </signal>

Dan Williams's avatar
Dan Williams committed
86 87
    <signal name="NewConnection">
      <tp:docstring>
88
        Emitted when a new connection has been added.
Dan Williams's avatar
Dan Williams committed
89 90 91 92 93 94 95
      </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
96

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    <tp:flags name="NM_SETTINGS_PERMISSIONS" value-prefix="NM_SETTINGS_PERMISSION" type="u">
      <tp:flag suffix="NONE" value="0x0">
        <tp:docstring>No permissions.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="CONNECTION_MODIFY" value="0x1">
        <tp:docstring>Can modify/add/delete connections.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="WIFI_SHARING_PROTECTED" value="0x2">
        <tp:docstring>Can share connections via a encrypted user-created WiFi network.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="WIFI_SHARING_OPEN" value="0x4">
        <tp:docstring>Can share connections via a open/unencrypted user-created WiFi network.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="HOSTNAME_MODIFY" value="0x8">
        <tp:docstring>Can modify the persistent system hostname.</tp:docstring>
      </tp:flag>
    </tp:flags>

Dan Williams's avatar
Dan Williams committed
115
  </interface>
116
</node>
Dan Williams's avatar
Dan Williams committed
117