api: clarify some parameters of GetSecrets and CancelGetSecrets

This commit is contained in:
Dan Williams
2013-04-15 14:18:14 -05:00
parent b292af8e1d
commit 7b1fe5428a

View File

@@ -46,7 +46,9 @@
Array of strings of key names in the requested setting for Array of strings of key names in the requested setting for
which NetworkManager thinks a secrets may be required, which NetworkManager thinks a secrets may be required,
and/or well-known identifiers and data that may be useful and/or well-known identifiers and data that may be useful
to the client in processing the secrets request. The Agent to the client in processing the secrets request. Note that
it's not always possible to determine which secret is
required, so in some cases no hints may be given. The Agent
should return any secrets it has, or that it thinks are should return any secrets it has, or that it thinks are
required, regardless of what hints NetworkManager sends required, regardless of what hints NetworkManager sends
in this request. in this request.
@@ -109,14 +111,17 @@
<method name="CancelGetSecrets"> <method name="CancelGetSecrets">
<tp:docstring> <tp:docstring>
Cancel a pending GetSecrets request for secrets of the given Cancel a pending GetSecrets request for secrets of the given
connection. Any matching request should be canceled. connection. Any GetSecrets request with the same
'connection_path' and 'setting_name' that are given in a
CancelGetSecrets request should be canceled.
</tp:docstring> </tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_cancel_get_secrets"/> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_cancel_get_secrets"/>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/> <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="connection_path" type="o" direction="in"> <arg name="connection_path" type="o" direction="in">
<tp:docstring> <tp:docstring>
Object path of the connection for which, if secrets are being Object path of the connection for which, if secrets for
requested, the request should be canceled. the given 'setting_name' are being requested, the request
should be canceled.
</tp:docstring> </tp:docstring>
</arg> </arg>
<arg name="setting_name" type="s" direction="in"> <arg name="setting_name" type="s" direction="in">