summaryrefslogtreecommitdiff
path: root/contrib/obexd-api-0.34-fixed/obexd-api.txt
blob: 6cfaac74634f6a16abf76fda54474a57b1256561 (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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
obexd API description
**********************************

Copyright (C) 2007-2010  Nokia Corporation
Copyright (C) 2007-2010  Marcel Holtmann <marcel@holtmann.org>


Manager hierarchy
===============

Service		org.openobex
Interface	org.openobex.Manager
Object path	/
Object name	OBEXManager

Methods
		void RegisterAgent(object agent)

			Register an agent to request authorization of 
			the user to accept/reject objects. Object push
			service needs to authorize each received object.

			Possible errors: org.openobex.Error.AlreadyExists

		void UnregisterAgent(object agent)

			This unregisters the agent that has been previously
			registered. The object path parameter must match the
			same value that has been used on registration.

			Possible errors: org.openobex.Error.DoesNotExist

Signals		SessionCreated(object session)
			
			Signal sent when OBEX connection has been accepted.
			(FTP only)

		SessionRemoved(object session)
			
			Sent when the transport is disconnected
			(FTP only)

		TransferStarted(object transfer)

			Signal sent when an object push operation starts.
			(OPP only)

		TransferCompleted(object transfer, boolean success)

			Signal sent when the object has been received
			or an error happens.
			(OPP only)


Transfer hierarchy
===============

Service		org.openobex
Interface	org.openobex.Transfer
Object path	/transfer{0, 1, 2, ...}
Object name	OBEXTransfer

Methods
		void Cancel()

			Stops the current transference.

Signals
		Progress(int32 total, int32 transfered)


Session hierarchy
===============

Service		org.openobex
Interface	org.openobex.Session
Object path	/session{0, 1, 2, ...}
Object name	OBEXSession

Methods
		dict GetProperties()


Signals		TBD


Properties
		string Address [readonly]

			Bluetooth device address or USB