summaryrefslogtreecommitdiffstats
path: root/doc/agent-api.txt
blob: febdcd3580658408378233fe71a6796ab2df98d1 (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
43
44
45
46
47
48
49
50
51
52
BlueZ D-Bus Agent API description
**********************************

Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com>


Agent hierarchy
===============

Service		unique name
Interface	org.bluez.Agent
Object path	freely definable

Methods		void Release()

			This method gets called when the service daemon
			unregisters the agent. An agent can use it to do
			cleanup tasks. There is no need to unregister the
			agent, because when this method gets called it has
			already been unregistered.

		string RequestPasskey(object device)

			This method gets called when the service daemon
			needs to get the passkey for an authentication. The
			return value is actual passkey.

			Possible errors: org.bluez.Error.Rejected
			                 org.bluez.Error.Canceled

		void Authorize(object device, string uuid)

			This method gets called when the service daemon
			needs to authorize a connection/service request.

			Possible errors: org.bluez.Error.Rejected
			                 org.bluez.Error.Canceled

		void ConfirmModeChange(string mode)

			This method gets called if a mode change is requested
			that needs to be confirmed by the user. An example
			would be leaving flight mode.

			Possible errors: org.bluez.Error.Rejected
			                 org.bluez.Error.Canceled

		void Cancel()

			This method gets called to indicate that the agent
			request failed before a reply was returned.