summaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.NetworkManager.AgentManager.xml
blob: e8df4872af99b3af816b6cffb43a4a1aabcb73f9 (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
<?xml version="1.0" encoding="UTF-8"?>
<node name="/org/freedesktop/NetworkManager/AgentManager">
  <!--
      org.freedesktop.NetworkManager.AgentManager:
      @short_description: Secret Agent Manager

  -->
  <interface name="org.freedesktop.NetworkManager.AgentManager">

    <!--
        Register:
        @identifier: 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).

        Called by secret Agents to register their ability to provide and save
        network secrets.
    -->
    <method name="Register">
      <arg name="identifier" type="s" direction="in"/>
    </method>

    <!--
        RegisterWithCapabilities:
        @identifier: See the Register() method's identifier argument.
        @capabilities: (<link linkend="NMSecretAgentCapabilities">NMSecretAgentCapabilities</link>) Indicates various agent capabilities to NetworkManager.

        Like Register() but indicates agent capabilities to NetworkManager.
    -->
    <method name="RegisterWithCapabilities">
      <arg name="identifier" type="s" direction="in"/>
      <arg name="capabilities" type="u" direction="in"/>
    </method>

    <!--
        Unregister:

        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.
    -->
    <method name="Unregister"/>
  </interface>
</node>