1ORG.BLUEZ.OBEX.FILETRANSFERL(i5n)ux System AdministraOtRiGo.nBLUEZ.OBEX.FILETRANSFER(5)
2
3
4

NAME

6       org.bluez.obex.FileTransfer  -  BlueZ D-Bus OBEX FileTransfer API docu‐
7       mentation
8

INTERFACE

10       Service
11              org.bluez.obex
12
13       Interface
14              org.bluez.obex.FileTransfer1
15
16       Object path
17              [Session object path]
18
19   Methods
20   void ChangeFolder(string folder)
21          Changes the current folder of the remote device.
22
23          Possible errors:
24
25          org.bluez.obex.Error.InvalidArguments
26
27          org.bluez.obex.Error.Failed
28
29   void CreateFolder(string folder)
30          Creates a new folder in the remote device.
31
32          Possible errors:
33
34          org.bluez.obex.Error.InvalidArguments
35
36          org.bluez.obex.Error.Failed
37
38   array{dict} ListFolder()
39          Returns a dictionary containing information about the current folder
40          content.
41
42          Possible return values:
43
44          string Name
45                 Object name in UTF-8 format.
46
47          string Type
48                 Either "folder" or "file".
49
50          uint64 Size
51                 Object size or number of items in folder.
52
53          string Permission
54                 Group, owner and other permission.
55
56          uint64 Modified
57                 Last change.
58
59          uint64 Accessed
60                 Last access.
61
62          uint64 Created
63                 Creation date.
64
65          Possible errors:
66
67          org.bluez.obex.Error.Failed
68
69   object, dict GetFile(string targetfile, string sourcefile)
70          Copies  the  contents of the source file (from remote device) to the
71          target file (on local filesystem).
72
73          If an empty target file is given, a name will be automatically  gen‐
74          erated for the temporary file.
75
76          The  returned  path  represents  the  newly  created transfer, which
77          should be used to find out if  the  content  has  been  successfully
78          transferred or if the operation fails.
79
80          The properties of this transfer are also returned along with the ob‐
81          ject   path,   to   avoid   a    call    to    GetProperties,    see
82          org.bluez.obex.Transfer(5) for the possible list of properties.
83
84          Possible errors:
85
86          org.bluez.obex.Error.InvalidArguments
87
88          org.bluez.obex.Error.Failed
89
90   object, dict PutFile(string sourcefile, string targetfile)
91          Copies  the  contents  of the source file (from local filesystem) to
92          the target file (on remote device).
93
94          The returned path  represents  the  newly  created  transfer,  which
95          should  be  used  to  find  out if the content has been successfully
96          transferred or if the operation fails.
97
98          The properties of this transfer are also returned along with the ob‐
99          ject    path,    to    avoid    a   call   to   GetProperties,   see
100          org.bluez.obex.Transfer(5) for the possible list of properties.
101
102          Possible errors:
103
104          org.bluez.obex.Error.InvalidArguments
105
106          org.bluez.obex.Error.Failed
107
108   void CopyFile(string sourcefile, string targetfile)
109          Copies the contents from source file to target file  on  the  remote
110          device.
111
112          Possible errors:
113
114          org.bluez.obex.Error.InvalidArguments
115
116          org.bluez.obex.Error.Failed
117
118   void MoveFile(string sourcefile, string targetfile)
119          Moves a file within the remote device from source file to the target
120          file.
121
122          Possible errors:
123
124          ;org.bluez.obex.Error.InvalidArguments:          :org.bluez.obex.Er‐
125          ror.Failed:
126
127   void Delete(string file)
128          Deletes the specified file/folder.
129
130          Possible errors:
131
132          org.bluez.obex.Error.InvalidArguments
133
134          org.bluez.obex.Error.Failed
135
136
137
138
139BlueZ                            October 2023   ORG.BLUEZ.OBEX.FILETRANSFER(5)