summaryrefslogtreecommitdiff
path: root/introspection/nm-agent-manager.xml
blob: d107442860a8e530c2aba822ad2980cadd64ca0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?xml version="1.0" encoding="UTF-8" ?>

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

    <method name="Register">
      <tp:docstring>
        Called by secret Agents to register their ability to provide and save
        network secrets.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_agent_manager_register"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="identifier" type="s" direction="in">
        <tp:docstring>
          Identifies this agent; only one agent in each user session may use the
          same identifier.  Identifier formatting follows the same rules as
          D-Bus bus names with the exception that the ':' character is not
          allowed.  The valid set of characters is "[A-Z][a-z][0-9]_-." and the
          identifier is limited in length to 255 characters with a minimum
          of 3 characters.  An example valid identifier is 'org.gnome.nm-applet'
          (without quotes).
        </tp:docstring>
      </arg>
    </method>

    <method name="RegisterWithCapabilities">
      <tp:docstring>
        Like Register() but indicates agent capabilities to NetworkManager.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_agent_manager_register_with_capabilities"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="identifier" type="s" direction="in">
        <tp:docstring>
            See the Register() method's identifier argument.
        </tp:docstring>
      </arg>
      <arg name="capabilities" type="u" direction="in" tp:type="NM_SECRET_AGENT_CAPABILITIES">
        <tp:docstring>
            Indicates various agent capabilities to NetworkManager.
        </tp:docstring>
      </arg>
    </method>

    <method name="Unregister">
      <tp:docstring>
        Called by secret Agents to notify NetworkManager that they will no
        longer handle requests for network secrets.  Agents are automatically
        unregistered when they disconnect from D-Bus.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_agent_manager_unregister"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
    </method>

  </interface>
</node>