1ORG.BLUEZ.OBEX.TRANSFER(5)Linux System AdministrationORG.BLUEZ.OBEX.TRANSFER(5)
2
3
4
6 org.bluez.obex.Transfer - BlueZ D-Bus OBEX Transfer API documentation
7
9 Service
10 org.bluez.obex
11
12 Interface
13 org.bluez.obex.Transfer1
14
15 Object path
16 [Session object path]/transfer{#}
17
18 Methods
19 void Cancel()
20 Cancels the current transference.
21
22 Possible errors:
23
24 org.bluez.obex.Error.NotAuthorized
25
26 org.bluez.obex.Error.InProgress
27
28 org.bluez.obex.Error.Failed
29
30 void Suspend()
31 Suspends transference.
32
33 Possible errors:
34
35 org.bluez.obex.Error.NotAuthorized
36
37 org.bluez.obex.Error.NotInProgress
38 If transfer is still in with Status "queued".
39
40 void Resume()
41 Resumes transference previously suspended with use of Suspend()
42 method.
43
44 Possible errors:
45
46 org.bluez.obex.Error.NotAuthorized
47
48 org.bluez.obex.Error.NotInProgress
49 If transfer is still in with Status "queued".
50
51 Properties
52 string Status [readonly]
53 Indicates the current status of the transfer.
54
55 Possible values:
56
57 "queued"
58
59 "active"
60
61 "suspended"
62
63 "complete"
64
65 "error"
66
67 object Session [readonly]
68 The object path of the session the transfer belongs to.
69
70 string Name [readonly, optional]
71 Name of the object being transferred.
72
73 Either Name or Type or both will be present.
74
75 string Type [readonly, optional]
76 Type of the object transferred being transferred.
77
78 Either Name or Type or both will be present.
79
80 uint64 Time [readonly, optional]
81 Time of the object being transferred if this is provided by the re‐
82 mote party.
83
84 uint64 Size [readonly, optional]
85 Size of the object being transferred.
86
87 If the size is unknown, then this property will not be present.
88
89 uint64 Transferred [readonly, optional]
90 Number of bytes transferred.
91
92 For transfers with Status set to "queued", this value will not be
93 present.
94
95 string Filename [readonly, optional]
96 Complete name of the file being received or sent.
97
98 For incoming object push transaction, this will be the proposed de‐
99 fault location and name. It can be overwritten by the Authorize‐
100 Push() in org.bluez.obex.Agent(5) and will be then updated accord‐
101 ingly.
102
103
104
105
106BlueZ October 2023 ORG.BLUEZ.OBEX.TRANSFER(5)