Package org.bluez.obex
Interface FileTransfer
- All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface FileTransfer
extends org.freedesktop.dbus.interfaces.DBusInterface
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.
Service: org.bluez.obex
Interface: org.bluez.obex.FileTransfer
Object path:
[Session object path]
Based on bluez Documentation: obex-api.txt.
Service: org.bluez.obex
Interface: org.bluez.obex.FileTransfer
Object path:
[Session object path]
-
Method Summary
Modifier and TypeMethodDescriptionvoidChangeFolder(String _folder) From bluez documentation:
Change the current folder of the remote device.
voidFrom bluez documentation:
Copy a file within the remote device from source file
to target file.
voidCreateFolder(String _folder) From bluez documentation:
Create a new folder in the remote device.
voidFrom bluez documentation:
Deletes the specified file/folder.
From bluez documentation:
Copy the source file (from remote device) to the
target file (on local filesystem).
If an empty target file is given, a name will be
automatically calculated for the temporary file.
The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.
The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.
From bluez documentation:
Returns a dictionary containing information about
the current folder content.
The following keys are defined:
string Name : Object name in UTF-8 format
string Type : Either "folder" or "file"
uint64 Size : Object size or number of items in
folder
string Permission : Group, owner and other
permission
uint64 Modified : Last change
uint64 Accessed : Last access
uint64 Created : Creation date
voidFrom bluez documentation:
Move a file within the remote device from source file
to the target file.
From bluez documentation:
Copy the source file (from local filesystem) to the
target file (on remote device).
The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.
The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.
Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface
getObjectPath, isRemote
-
Method Details
-
ChangeFolder
From bluez documentation:
Change the current folder of the remote device.
- Parameters:
_folder- folder- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezFailedException- on failure
-
CreateFolder
From bluez documentation:
Create a new folder in the remote device.
- Parameters:
_folder- folder- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezFailedException- on failure
-
ListFolder
From bluez documentation:
Returns a dictionary containing information about
the current folder content.
The following keys are defined:
string Name : Object name in UTF-8 format
string Type : Either "folder" or "file"
uint64 Size : Object size or number of items in
folder
string Permission : Group, owner and other
permission
uint64 Modified : Last change
uint64 Accessed : Last access
uint64 Created : Creation date
- Returns:
- Map<String, Variant<?>>[] - maybe null
- Throws:
BluezFailedException- on failure
-
GetFile
TwoTuple<org.freedesktop.dbus.DBusPath,Map<String, GetFileorg.freedesktop.dbus.types.Variant<?>>> (String _targetfile, String _sourcefile) throws BluezInvalidArgumentsException, BluezFailedException From bluez documentation:
Copy the source file (from remote device) to the
target file (on local filesystem).
If an empty target file is given, a name will be
automatically calculated for the temporary file.
The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.
The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.
- Parameters:
_targetfile- targetfile_sourcefile- sourcefile- Returns:
- TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezFailedException- on failure
-
PutFile
TwoTuple<org.freedesktop.dbus.DBusPath,Map<String, PutFileorg.freedesktop.dbus.types.Variant<?>>> (String _sourcefile, String _targetfile) throws BluezInvalidArgumentsException, BluezFailedException From bluez documentation:
Copy the source file (from local filesystem) to the
target file (on remote device).
The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.
The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.
- Parameters:
_sourcefile- sourcefile_targetfile- targetfile- Returns:
- TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezFailedException- on failure
-
CopyFile
void CopyFile(String _sourcefile, String _targetfile) throws BluezInvalidArgumentsException, BluezFailedException From bluez documentation:
Copy a file within the remote device from source file
to target file.
- Parameters:
_sourcefile- sourcefile_targetfile- targetfile- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezFailedException- on failure
-
MoveFile
void MoveFile(String _sourcefile, String _targetfile) throws BluezInvalidArgumentsException, BluezFailedException From bluez documentation:
Move a file within the remote device from source file
to the target file.
- Parameters:
_sourcefile- sourcefile_targetfile- targetfile- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezFailedException- on failure
-
Delete
From bluez documentation:
Deletes the specified file/folder.
- Parameters:
_file- file- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezFailedException- on failure
-