Contents

BluezQt::ObexManager Class

class BluezQt::ObexManager

OBEX manager. More...

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

Properties

Public Functions

ObexManager(QObject *parent = nullptr)
BluezQt::InitObexManagerJob *init()
bool isInitialized() const
bool isOperational() const
BluezQt::ObexSessionPtr sessionForPath(const QDBusObjectPath &path) const
QList<BluezQt::ObexSessionPtr> sessions() const

Public Slots

BluezQt::PendingCall *createSession(const QString &destination, const QVariantMap &args)
BluezQt::PendingCall *registerAgent(BluezQt::ObexAgent *agent)
BluezQt::PendingCall *removeSession(const QDBusObjectPath &session)
BluezQt::PendingCall *unregisterAgent(BluezQt::ObexAgent *agent)

Signals

void operationalChanged(bool operational)
void sessionAdded(BluezQt::ObexSessionPtr session)
void sessionRemoved(BluezQt::ObexSessionPtr session)

Static Public Members

BluezQt::PendingCall *startService()

Detailed Description

The entry point to communicate with session BlueZ obex daemon.

You must call init() before other functions can be used.

Note: If manager is not operational, all methods that returns a PendingCall will fail with PendingCall::InternalError.

Property Documentation

[read-only] initialized : const bool

Access functions:

bool isInitialized() const

[read-only] operational : const bool

Access functions:

bool isOperational() const

Notifier signal:

void operationalChanged(bool operational)

Member Function Documentation

[explicit] ObexManager::ObexManager(QObject *parent = nullptr)

Creates a new ObexManager object as a child of parent.

[slot] BluezQt::PendingCall *ObexManager::createSession(const QString &destination, const QVariantMap &args)

Creates a new OBEX session with the address of the target device destination and the given session parameters args.

The args parameter is a dictionary to hold optional or type-specific parameters.

Typical parameters:

  • QString target - type of session to be created
  • QString source - device address to be used

Supported targets:

Possible errors:

Returns QDBusObjectPath pending call.

BluezQt::InitObexManagerJob *ObexManager::init()

Creates a new init manager job.

bool ObexManager::isInitialized() const

Returns whether the manager is initialized.

Note: Getter function for property initialized.

bool ObexManager::isOperational() const

Returns whether the manager is operational.

The manager is operational when initialization was successful and the BlueZ session daemon is running.

Note: Getter function for property operational.

[signal] void ObexManager::operationalChanged(bool operational)

Indicates that the operational state has changed.

Note: Notifier signal for property operational.

[slot] BluezQt::PendingCall *ObexManager::registerAgent(BluezQt::ObexAgent *agent)

Registers an agent.

This agent will be used to authorize an incoming object push requests.

Possible errors:

Returns void pending call.

[slot] BluezQt::PendingCall *ObexManager::removeSession(const QDBusObjectPath &session)

Removes an existing OBEX session.

Possible errors:

Returns void pending call.

[signal] void ObexManager::sessionAdded(BluezQt::ObexSessionPtr session)

Indicates that the session was added.

BluezQt::ObexSessionPtr ObexManager::sessionForPath(const QDBusObjectPath &path) const

Returns a session for the specified path.

The path does not need to be equal to the ObexSession path, startsWith test is performed in the search. That means you can use this method to get ObexSession from path returned by createSession().

[signal] void ObexManager::sessionRemoved(BluezQt::ObexSessionPtr session)

Indicates that the session was removed.

QList<BluezQt::ObexSessionPtr> ObexManager::sessions() const

Returns a list of all sessions.

Note: Getter function for property sessions.

[static] BluezQt::PendingCall *ObexManager::startService()

Attempts to start org.bluez.obex service by D-Bus activation.

Possible return values are 1 if the service was started, 2 if the service is already running, or error if the service could not be started.

Returns quint32 pending call.

[slot] BluezQt::PendingCall *ObexManager::unregisterAgent(BluezQt::ObexAgent *agent)

Unregisters an agent.

Possible errors:

Returns void pending call