api: clarify expected agent behavior for GetSecrets and saving secrets

Agents are expected to save any new/updated secrets returned to
NetworkManager from a GetSecrets call, as it would be silly to return
those same secrets right back to the agent via SaveSecrets when the
agent is perfectly capable of saving the secrets itself without
round-tripping to NetworkManager and back.
This commit is contained in:
Dan Williams 2013-04-16 15:02:17 -05:00
parent 7b1fe5428a
commit b6d2ae429f

View file

@ -17,7 +17,11 @@
<method name="GetSecrets">
<tp:docstring>
Retrieve and return stored secrets, if any, or request new
secrets from the agent's user.
secrets from the agent's user. If user interaction is allowed
and the user enters new secrets, the agent is expected to save
the new secrets to persistent storage (if the secret's flags
include AGENT_OWNED) as NetworkManager will not send these
secrets back to the same agent via a SaveSecrets() call.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_get_secrets"/>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>