Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

BluezQt::ObexTransfer Class

OBEX transfer. More...

• Header: #include <BluezQt/ObexTransfer>
• CMake: find_package(KF6 REQUIRED COMPONENTS BluezQt)
target_link_libraries(mytarget PRIVATE KF6::BluezQt)
• Inherits: QObject

List of all members, including inherited members

#Public Types

• enum ObexTransfer::Status

#Properties

• [read-only] fileName : QString
• [read-only] name : QString
• [read-only] size : quint64
• [read-only] status : Status
• [read-only] suspendable : bool
• [read-only] time : quint64
• [read-only] transferred : quint64
• [read-only] type : QString

#Public Functions

• BluezQt::PendingCall *cancel()
• QString fileName() const
• bool isSuspendable() const
• QString name() const
• QDBusObjectPath objectPath() const
• BluezQt::PendingCall *resume()
• quint64 size() const
• BluezQt::ObexTransfer::Status status() const
• BluezQt::PendingCall *suspend()
• quint64 time() const
• BluezQt::ObexTransferPtr toSharedPtr() const
• quint64 transferred() const
• QString type() const

#Signals

• void fileNameChanged(const QString &fileName)
• void statusChanged(BluezQt::ObexTransfer::Status status)
• void transferredChanged(quint64 transferred)

#Detailed Description

This class represents transfer of one file.

#Member Type Documentation

#enum ObexTransfer::Status

Transfer status.

Constant	Value	Description
BluezQt::ObexTransfer::Queued	0	Indicates that the transfer is queued.
BluezQt::ObexTransfer::Active	1	Indicates that the transfer is active.
BluezQt::ObexTransfer::Suspended	2	Indicates that the transfer is suspended.
BluezQt::ObexTransfer::Complete	3	Indicates that the transfer have completed successfully.
BluezQt::ObexTransfer::Error	4	Indicates that the transfer have failed with error.
BluezQt::ObexTransfer::Unknown	5	Indicates that the transfer status is unknown.

#Property Documentation

#[read-only] fileName : QString

Access functions:

• QString fileName() const

Notifier signal:

• void fileNameChanged(const QString &fileName)

#[read-only] name : QString

Access functions:

• QString name() const

#[read-only] size : quint64

Access functions:

• quint64 size() const

#[read-only] status : Status

Access functions:

• BluezQt::ObexTransfer::Status status() const

Notifier signal:

• void statusChanged(BluezQt::ObexTransfer::Status status)

#[read-only] suspendable : bool

Access functions:

• bool isSuspendable() const

#[read-only] time : quint64

Access functions:

• quint64 time() const

#[read-only] transferred : quint64

Access functions:

• quint64 transferred() const

Notifier signal:

• void transferredChanged(quint64 transferred)

#[read-only] type : QString

Access functions:

• QString type() const

#Member Function Documentation

#BluezQt::PendingCall *ObexTransfer::cancel()

Stops the current transfer.

Possible errors:

• PendingCall::NotAuthorized
• PendingCall::InProgress
• PendingCall::Failed

Returns void pending call.

#QString ObexTransfer::fileName() const

Returns the full name of the transferred file.

Note: Getter function for property fileName.

#[signal] void ObexTransfer::fileNameChanged(const QString &fileName)

Indicates that the transferred fileName has changed.

Note: Notifier signal for property fileName.

#bool ObexTransfer::isSuspendable() const

Returns whether the transfer is suspendable.

Note: Getter function for property suspendable.

#QString ObexTransfer::name() const

Returns the name of the transferred object.

Note: Getter function for property name.

#QDBusObjectPath ObexTransfer::objectPath() const

Returns the D-Bus object path of the transfer.

#BluezQt::PendingCall *ObexTransfer::resume()

Resumes the current transfer.

Possible errors:

• PendingCall::NotAuthorized
• PendingCall::NotInProgress

Returns void pending call.

#quint64 ObexTransfer::size() const

Returns the total size of the transferred object.

Note: Getter function for property size.

#BluezQt::ObexTransfer::Status ObexTransfer::status() const

Returns the status of the transfer.

Note: Getter function for property status.

#[signal] void ObexTransfer::statusChanged(BluezQt::ObexTransfer::Status status)

Indicates that the status of transfer has changed.

Note: Notifier signal for property status.

#BluezQt::PendingCall *ObexTransfer::suspend()

Suspends the current transfer.

Only suspendable transfers can be suspended.

Possible errors:

• PendingCall::NotAuthorized
• PendingCall::NotInProgress

Returns void pending call.

See also isSuspendable()

#quint64 ObexTransfer::time() const

Returns the time of the transferred object.

Note: Getter function for property time.

#BluezQt::ObexTransferPtr ObexTransfer::toSharedPtr() const

Returns a shared pointer from this.

#quint64 ObexTransfer::transferred() const

Returns the number of bytes transferred.

Note: Getter function for property transferred.

#[signal] void ObexTransfer::transferredChanged(quint64 transferred)

Indicates that the number of transferred bytes has changed.

Note: Notifier signal for property transferred.

#QString ObexTransfer::type() const

Returns the type of the transferred object.

Note: Getter function for property type.