Blob: org.bluez.obex.Transfer.rst

Blob id: f053def7929bc12309d6ba0958e8794c50dafd43

Size: 2.5 KB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
=======================
org.bluez.obex.Transfer
=======================

-------------------------------------------
BlueZ D-Bus OBEX Transfer API documentation
-------------------------------------------

:Version: BlueZ
:Date: October 2023
:Manual section: 5
:Manual group: Linux System Administration

Interface
=========

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

Methods
-------

void Cancel()
`````````````

Cancels the current transference.

Possible errors:

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

void Suspend()
``````````````

Suspends transference.

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.

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":

object Session [readonly]
`````````````````````````

The object path of the session the transfer belongs to.

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.

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 the **AuthorizePush()** in
**org.bluez.obex.Agent(5)** and will be then updated accordingly.