Add some more callbacks to agent documentation
[platform/upstream/connman.git] / doc / agent-api.txt
1 Agent hierarchy
2 ===============
3
4 Service         unique name
5 Interface       org.moblin.connman.Agent
6 Object path     freely definable
7
8 Methods         void Release()
9
10                         This method gets called when the service daemon
11                         unregisters the agent. An agent can use it to do
12                         cleanup tasks. There is no need to unregister the
13                         agent, because when this method gets called it has
14                         already been unregistered.
15
16                 void ReportError(object service, string error)
17
18                         This method gets called when an error has to be
19                         reported to the user.
20
21                         A special return value can be used to trigger a
22                         retry of the failed transaction.
23
24                         Possible Errors: [service].Error.Retry
25
26                 string RequestPassphrase(object service)
27
28                         This method gets called when trying to connect to
29                         a service and a passphrase is missing.
30
31                         The return value should be the passphrase string or
32                         an error indicating that the request got cannceled.
33
34                         Possible Errors: [service].Error.Canceled
35
36                 void Cancel()
37
38                         This method gets called to indicate that the agent
39                         request failed before a reply was returned.