org.bluez.obex.Transfer - BlueZ D-Bus OBEX Transfer API documentation
Contents
Interface
Service
org.bluez.obex
Interface
org.bluez.obex.Transfer1
Objectpath
[Session object path]/transfer{#}
MethodsvoidCancel()
Cancels the current transference.
Possible errors:
org.bluez.obex.Error.NotAuthorizedorg.bluez.obex.Error.InProgressorg.bluez.obex.Error.FailedvoidSuspend()
Suspends transference.
Possible errors:
org.bluez.obex.Error.NotAuthorizedorg.bluez.obex.Error.NotInProgress
If transfer is still in with Status"queued".
voidResume()
Resumes transference previously suspended with use of Suspend() method.
Possible errors:
org.bluez.obex.Error.NotAuthorizedorg.bluez.obex.Error.NotInProgress
If transfer is still in with Status"queued".
PropertiesstringStatus[readonly]
Indicates the current status of the transfer.
Possible values:
"queued""active""suspended""complete""error"objectSession[readonly]
The object path of the session the transfer belongs to.
stringName[readonly,optional]
Name of the object being transferred.
Either Name or Type or both will be present.
stringType[readonly,optional]
Type of the object transferred being transferred.
Either Name or Type or both will be present.
uint64Time[readonly,optional]
Time of the object being transferred if this is provided by the remote party.
uint64Size[readonly,optional]
Size of the object being transferred.
If the size is unknown, then this property will not be present.
uint64Transferred[readonly,optional]
Number of bytes transferred.
For transfers with Status set to "queued", this value will not be present.
stringFilename[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) and will be then updated accordingly.
BlueZ October 2023 ORG.BLUEZ.OBEX.TRANSFER(5)
Name
org.bluez.obex.Transfer - BlueZ D-Bus OBEX Transfer API documentation
