org.bluez.obex.Transfer(5) Linux System Administration org.bluez.obex.Transfer(5)

# [Name](#Name)

org.bluez.obex.Transfer - BlueZ D-Bus OBEX Transfer API documentation

# [Interface](#Interface)

[**Service**](#Service)

org.bluez.obex

[**Interface**](#Interface~2)

org.bluez.obex.Transfer1

[**Object path**](#Object)

\[Session object path]/transfer{#}

## [Methods](#Methods)

## [void Cancel()](#void_Cancel%28%29)

Cancels the current transference.

Possible errors:

[**org.bluez.obex.Error.NotAuthorized**](#org.bluez.obex.Error.NotAuthorized)

[**org.bluez.obex.Error.InProgress**](#org.bluez.obex.Error.InProgress)

[**org.bluez.obex.Error.Failed**](#org.bluez.obex.Error.Failed)

## [void Suspend()](#void_Suspend%28%29)

Suspends transference.

Possible errors:

[**org.bluez.obex.Error.NotAuthorized**](#org.bluez.obex.Error.NotAuthorized~2)

[**org.bluez.obex.Error.NotInProgress**](#org.bluez.obex.Error.NotInProgress)

If transfer is still in with **Status** **"queued"**.

## [void Resume()](#void_Resume%28%29)

Resumes transference previously suspended with use of **Suspend()** method.

Possible errors:

[**org.bluez.obex.Error.NotAuthorized**](#org.bluez.obex.Error.NotAuthorized~3)

[**org.bluez.obex.Error.NotInProgress**](#org.bluez.obex.Error.NotInProgress~2)

If transfer is still in with **Status** **"queued"**.

## [Properties](#Properties)

## [string Status \[readonly\]](#string_Status__readonly_)

Indicates the current status of the transfer.

Possible values:

**"queued"**

**"active"**

**"suspended"**

**"complete"**

**"error"**

## [object Session \[readonly\]](#object_Session__readonly_)

The object path of the session the transfer belongs to.

## [string Name \[readonly, optional\]](#string_Name__readonly,_optional_)

Name of the object being transferred.

Either Name or Type or both will be present.

## [string Type \[readonly, optional\]](#string_Type__readonly,_optional_)

Type of the object transferred being transferred.

Either Name or Type or both will be present.

## [uint64 Time \[readonly, optional\]](#uint64_Time__readonly,_optional_)

Time of the object being transferred if this is provided by the remote party.

## [uint64 Size \[readonly, optional\]](#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\]](#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\]](#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 the **AuthorizePush()** in [**org.bluez.obex.Agent(5)**](/man/os/bluez/org.bluez.obex.Agent.5) and will be then updated accordingly.

October 2023 BlueZ

---

Document: org.bluez.obex.Transfer(5) from bluez 5.87-r4 (Chainguard OS)
Source: https://github.com/bluez/bluez