BluezQt::ObexAgent Class
class BluezQt::ObexAgentBluetooth OBEX agent. More...
| Header: | #include <BluezQt/ObexAgent> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS BluezQt)target_link_libraries(mytarget PRIVATE KF6::BluezQt) |
| Inherits: | QObject |
Public Functions
| ObexAgent(QObject *parent = nullptr) | |
| virtual void | authorizePush(BluezQt::ObexTransferPtr transfer, BluezQt::ObexSessionPtr session, const BluezQt::Request<QString> &request) |
| virtual void | cancel() |
| virtual QDBusObjectPath | objectPath() const = 0 |
| virtual void | release() |
Detailed Description
This class represents a Bluetooth OBEX agent.
The agent is used to authorize an incoming object push requests.
Note: The return value of request will be sent asynchronously with Request class. It is also possible to cancel/reject the request.
Member Function Documentation
[explicit] ObexAgent::ObexAgent(QObject *parent = nullptr)
Creates a new ObexAgent object as a child of parent.
[virtual] void ObexAgent::authorizePush(BluezQt::ObexTransferPtr transfer, BluezQt::ObexSessionPtr session, const BluezQt::Request<QString> &request)
Requests the agent to authorize an incoming object push request.
This method gets called when the Bluetooth daemon needs to accept/reject a Bluetooth object push request.
The return value should be full path where the incoming object will be saved.
The ObexTransfer::fileName() contains the default location and name that can be returned.
You can use session to get the device and adapter this transfer belongs to.
transfer The transfer object.
session The transfer session.
request The request to be used for sending a reply.
[virtual] void ObexAgent::cancel()
Indicates that the agent request failed before receiving reply.
This method gets called to indicate that the agent request failed before a reply was returned.
It cancels the previous request.
[pure virtual] QDBusObjectPath ObexAgent::objectPath() const
Returns the D-Bus object path of the agent.
The path where the agent will be registered.
Note: You must provide valid object path!
[virtual] void ObexAgent::release()
Indicates that the agent was unregistered.
This method gets called when the Bluetooth daemon unregisters the agent.
An agent can use it to do cleanup tasks. There is no need to unregister the agent, because when this method gets called it has already been unregistered.