dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-agent-manager.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <node name="/org/freedesktop/NetworkManager/AgentManager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4   <interface name="org.freedesktop.NetworkManager.AgentManager">
5
6     <method name="Register">
7       <annotation name="org.gtk.GDBus.DocString" value="
8         Called by secret Agents to register their ability to provide and save
9         network secrets.
10       " />
11       <arg name="identifier" type="s" direction="in">
12         <annotation name="org.gtk.GDBus.DocString" value="
13           Identifies this agent; only one agent in each user session may use the
14           same identifier.  Identifier formatting follows the same rules as
15           D-Bus bus names with the exception that the ':' character is not
16           allowed.  The valid set of characters is &quot;[A-Z][a-z][0-9]_-.&quot; and the
17           identifier is limited in length to 255 characters with a minimum
18           of 3 characters.  An example valid identifier is 'org.gnome.nm-applet'
19           (without quotes).
20         " />
21       </arg>
22     </method>
23
24     <method name="RegisterWithCapabilities">
25       <annotation name="org.gtk.GDBus.DocString" value="
26         Like Register() but indicates agent capabilities to NetworkManager.
27       " />
28       <arg name="identifier" type="s" direction="in">
29         <annotation name="org.gtk.GDBus.DocString" value="
30             See the Register() method's identifier argument.
31         " />
32       </arg>
33       <arg name="capabilities" type="u" direction="in" tp:type="NM_SECRET_AGENT_CAPABILITIES">
34         <annotation name="org.gtk.GDBus.DocString" value="
35             Indicates various agent capabilities to NetworkManager.
36         " />
37       </arg>
38     </method>
39
40     <method name="Unregister">
41       <annotation name="org.gtk.GDBus.DocString" value="
42         Called by secret Agents to notify NetworkManager that they will no
43         longer handle requests for network secrets.  Agents are automatically
44         unregistered when they disconnect from D-Bus.
45       " />
46     </method>
47
48   </interface>
49 </node>
50