BluezQt 5.109.0
|
Bluetooth agent. More...
#include <BluezQt/Agent>
Public Types | |
enum | Capability { DisplayOnly = 0 , DisplayYesNo = 1 , KeyboardOnly = 2 , NoInputNoOutput = 3 } |
The input/output capabilities of Agent. More... | |
Properties | |
Capability | capability |
Public Member Functions | |
Agent (QObject *parent=nullptr) | |
Creates a new Agent object. | |
virtual void | authorizeService (DevicePtr device, const QString &uuid, const Request<> &request) |
Requests the agent to authorize a connection/service request. | |
virtual void | cancel () |
Indicate that the agent request failed before receiving reply. | |
virtual Capability | capability () const |
Input/output capability of the agent. | |
virtual void | displayPasskey (DevicePtr device, const QString &passkey, const QString &entered) |
Requests the agent to display a passkey. | |
virtual void | displayPinCode (DevicePtr device, const QString &pinCode) |
Requests the agent to display a PIN code. | |
virtual QDBusObjectPath | objectPath () const =0 |
D-Bus object path of the agent. | |
virtual void | release () |
Indicates that the agent was unregistered. | |
virtual void | requestAuthorization (DevicePtr device, const Request<> &request) |
Requests the agent to authorize an incoming pairing attempt. | |
virtual void | requestConfirmation (DevicePtr device, const QString &passkey, const Request<> &request) |
Requests the agent to confirm a passkey. | |
virtual void | requestPasskey (DevicePtr device, const Request< quint32 > &request) |
Requests a passkey from the agent. | |
virtual void | requestPinCode (DevicePtr device, const Request< QString > &request) |
Requests a PIN code from the agent. | |
Bluetooth agent.
This class represents a Bluetooth agent.
The agent is used in pairing process to do various actions.
The input/output capabilities of Agent.
|
explicit |
Creates a new Agent object.
parent |
|
virtual |
Requests the agent to authorize a connection/service request.
This method gets called when the Bluetooth daemon needs to authorize a connection/service request.
device | device that invoked the action |
uuid | UUID of service |
request | request to be used for sending reply |
|
virtual |
Indicate 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.
|
virtual |
Input/output capability of the agent.
By default, this method returns DisplayYesNo.
|
virtual |
Requests the agent to display a passkey.
This method gets called when the Bluetooth daemon needs to display a passkey for an authentication.
When the passkey needs no longer to be displayed, the cancel() method will be called.
device | device that invoked the action |
passkey | passkey to be displayed |
entered | number of already typed keys on the remote side |
|
virtual |
Requests the agent to display a PIN code.
This method gets called when the Bluetooth daemon needs to display a pincode for an authentication.
When the PIN code needs no longer to be displayed, the cancel() method will be called.
device | device that invoked the action |
pinCode | PIN code to be displayed |
|
pure virtual |
D-Bus object path of the agent.
The path where the agent will be registered.
|
virtual |
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.
|
virtual |
Requests the agent to authorize an incoming pairing attempt.
This method gets called to request the user to authorize an incoming pairing attempt which would in other circumstances trigger the just-works model.
device | device that invoked the action |
request | request to be used for sending reply |
|
virtual |
Requests the agent to confirm a passkey.
This method gets called when the Bluetooth daemon needs to confirm a passkey for an authentication.
device | device that invoked the action |
passkey | passkey to be confirmed |
request | request to be used for sending reply |
|
virtual |
Requests a passkey from the agent.
This method gets called when the Bluetooth daemon needs to get the passkey for an authentication.
The return value should be a numeric value between 0-999999.
device | device that invoked the action |
request | request to be used for sending reply |
|
virtual |
Requests a PIN code from the agent.
This method gets called when the Bluetooth daemon needs to get the PIN code for an authentication.
The return value should be a string of 1-16 characters length. The string can be alphanumeric.
device | device that invoked the action |
request | request to be used for sending reply |