aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/org.bluez.obex.Agent.rst
blob: b832e278c86abfda9f4f4a59912d7c44bcb2c32b (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
53
54
====================
org.bluez.obex.Agent
====================

----------------------------------------
BlueZ D-Bus OBEX Agent API documentation
----------------------------------------

:Version: BlueZ
:Date: October 2023
:Manual section: 5
:Manual group: Linux System Administration

Interface
=========

;Service:	unique name
:Interface:	org.bluez.obex.Agent1
:Object path:	freely definable

Methods
-------

void Release()
``````````````

	This method gets called when **obexd(8)** 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 AuthorizePush(object transfer)
`````````````````````````````````````

	This method gets called when the **obexd(8)** needs to accept/reject a
	Bluetooth object push request.

	Returns the full path (including the filename) or the folder name
	suffixed with '/' where the object shall be stored.

	The transfer object, see **org.bluez.obex.Transfer(5)** will contain a
	Filename property that contains the default location and name that can
	be returned.

	Possible errors:

	:org.bluez.obex.Error.Rejected:
	:org.bluez.obex.Error.Canceled:

void Cancel()
`````````````

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