org.bluez...x.Transfer(5)

💅 org.bluez.obex.Transfer — BlueZ D-Bus OBEX Transfer API 💅

okay bestie, welcome to the manual page org.bluez...x.Transfer(5) ✨ this is literally the BlueZ D-Bus OBEX Transfer API documentation, straight outta the Linux System Administration section of the manual. Periodt. We're gonna get you fluent without the boring-manpage voice, no cap 🫶

---

🌸 NAME 🌸

org.bluez.obex.Transfer — BlueZ D-Bus OBEX Transfer API documentation. That's the whole name section, bestie — short, sweet, and iconic ✨

---

🔌 INTERFACE 🔌

Here's the plug-in situation, no cap:

• Service — org.bluez.obex
• Interface — org.bluez.obex.Transfer1
• Object path — [Session object path]/transfer{#}

The object path is giving session-core energy — it lives under a Session object path, with transfer{#} on the end 💅

---

✨ METHODS ✨

🛑 void Cancel()

Cancels the current transference. Bye bestie, that transference is cancelled 💀

Possible errors:

• org.bluez.obex.Error.NotAuthorized
• org.bluez.obex.Error.InProgress
• org.bluez.obex.Error.Failed

⏸️ void Suspend()

Suspends transference. It's giving pause the group chat ⏸️

Possible errors:

• org.bluez.obex.Error.NotAuthorized
• org.bluez.obex.Error.NotInProgress — if transfer is still in with Status "queued".

▶️ void Resume()

Resumes transference previously suspended with use of Suspend() method. Welcome back, bestie 🫶 the transfer was on a little break.

Possible errors:

• org.bluez.obex.Error.NotAuthorized
• org.bluez.obex.Error.NotInProgress — if transfer is still in with Status "queued".

---

🎀 PROPERTIES 🎀

string Status [readonly]

Indicates the current status of the transfer.

Possible values:

• "queued"
• "active"
• "suspended"
• "complete"
• "error"

Vibe check: those are the possible values, periodt.

object Session [readonly]

The object path of the session the transfer belongs to. Lowkey your link back to the session.

string Name [readonly, optional]

Name of the object being transferred.

Either Name or Type or both will be present.

string Type [readonly, optional]

Type of the object transferred being transferred.

Either Name or Type or both will be present.

uint64 Time [readonly, optional]

Time of the object being transferred if this is provided by the remote party. Remote party says what it says ✨

uint64 Size [readonly, optional]

Size of the object being transferred.

If the size is unknown, then this property will not be present.

uint64 Transferred [readonly, optional]

Number of bytes transferred.

For transfers with Status set to "queued", this value will not be present.

string Filename [readonly, optional]

Complete name of the file being received or sent.

For incoming object push transaction, this will be the proposed default location and name. It can be overwritten by AuthorizePush() in org.bluez.obex.Agent(5) and will be then updated accordingly.

Obsessed with the detail: that filename is a proposal until AuthorizePush() says otherwise 🎀

---

mwah 💋 — that's the whole page, and it comes from BlueZ, dated October 2023, under the manual name org.bluez...x.Transfer(5).