org.bluez...leTransfer(5)

πŸ’– NAME πŸ’–

Okay bestie, you're looking at the org.bluez...leTransfer(5) manual page β€” it's the BlueZ D-Bus OBEX FileTransfer API documentation, living under Linux System Administration. This is the file-transfer interface for OBEX sessions, and it's giving remote-file-manager main character energy. πŸ¦‹

✨ INTERFACE ✨

Here's the D-Bus vibe check:

  • Service β€” org.bluez.obex
  • Interface β€” org.bluez.obex.FileTransfer1
  • Object path β€” [Session object path]

πŸŽ€ METHODS πŸŽ€

void ChangeFolder(string folder)

Changes the current folder of the remote device. Very "we're moving to a different directory" of it. πŸ’…

Possible errors:

  • org.bluez.obex.Error.InvalidArguments
  • org.bluez.obex.Error.Failed

void CreateFolder(string folder)

Creates a new folder in the remote device. New folder, who dis? πŸŽ€

Possible errors:

  • org.bluez.obex.Error.InvalidArguments
  • org.bluez.obex.Error.Failed

array{dict} ListFolder()

Returns a dictionary containing information about the current folder content. It's giving "let me see what's in here" energy. πŸ‘€

Possible return values:

  • 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.

Possible errors:

  • org.bluez.obex.Error.Failed

object, dict GetFile(string targetfile, string sourcefile)

Copies the contents of the source file (from the remote device) to the target file (on the local filesystem).

If an empty target file is given, a name will be automatically generated for the temporary file.

The returned path is the newly created transfer, and you should use it to find out if the content was successfully transferred or if the operation fails.

You also get the transfer properties back along with the object path, so you don't need to call GetProperties β€” see org.bluez.obex.Transfer(5) for the possible list of properties.

Possible errors:

  • org.bluez.obex.Error.InvalidArguments
  • org.bluez.obex.Error.Failed

object, dict PutFile(string sourcefile, string targetfile)

Copies the contents of the source file (from the local filesystem) to the target file (on the remote device).

The returned path is the newly created transfer, and you should use it to find out if the content was successfully transferred or if the operation fails.

You also get the transfer properties back along with the object path, so you don't need to call GetProperties β€” see org.bluez.obex.Transfer(5) for the possible list of properties.

Possible errors:

  • org.bluez.obex.Error.InvalidArguments
  • org.bluez.obex.Error.Failed

void CopyFile(string sourcefile, string targetfile)

Copies the contents from source file to target file on the remote device. Copy-paste but make it Bluetooth. πŸ”₯

Possible errors:

  • org.bluez.obex.Error.InvalidArguments
  • org.bluez.obex.Error.Failed

void MoveFile(string sourcefile, string targetfile)

Moves a file within the remote device from source file to the target file. It's the "same file, different address" moment. πŸ’«

Possible errors:

  • org.bluez.obex.Error.InvalidArguments
  • org.bluez.obex.Error.Failed

void Delete(string file)

Deletes the specified file/folder. Poof, gone, no cap. πŸ’€

Possible errors:

  • org.bluez.obex.Error.InvalidArguments
  • org.bluez.obex.Error.Failed

That's the whole page, bestie. Source/version: BlueZ; date: October 2023. Go off and happy file-transferring. πŸ’–βœ¨

πŸ“¦ where this page comes from