BluezQt 5.109.0
Public Types | Properties | Public Member Functions | List of all members
BluezQt::Agentabstract

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.
 

Detailed Description

Bluetooth agent.

This class represents a Bluetooth agent.

The agent is used in pairing process to do various actions.

Note
The return value of requests will be sent asynchronously with Request class. It is also possible to cancel/reject all requests.

Member Enumeration Documentation

◆ Capability

The input/output capabilities of Agent.

Constructor & Destructor Documentation

◆ Agent()

BluezQt::Agent::Agent ( QObject *  parent = nullptr)
explicit

Creates a new Agent object.

Parameters
parent

Member Function Documentation

◆ authorizeService()

virtual void BluezQt::Agent::authorizeService ( DevicePtr  device,
const QString &  uuid,
const Request<> &  request 
)
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.

Parameters
devicedevice that invoked the action
uuidUUID of service
requestrequest to be used for sending reply

◆ cancel()

virtual void BluezQt::Agent::cancel ( )
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.

◆ capability()

virtual Capability BluezQt::Agent::capability ( ) const
virtual

Input/output capability of the agent.

By default, this method returns DisplayYesNo.

Returns
capability of agent

◆ displayPasskey()

virtual void BluezQt::Agent::displayPasskey ( DevicePtr  device,
const QString &  passkey,
const QString &  entered 
)
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.

Parameters
devicedevice that invoked the action
passkeypasskey to be displayed
enterednumber of already typed keys on the remote side

◆ displayPinCode()

virtual void BluezQt::Agent::displayPinCode ( DevicePtr  device,
const QString &  pinCode 
)
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.

Parameters
devicedevice that invoked the action
pinCodePIN code to be displayed

◆ objectPath()

virtual QDBusObjectPath BluezQt::Agent::objectPath ( ) const
pure virtual

D-Bus object path of the agent.

The path where the agent will be registered.

Note
You must provide valid object path!
Returns
object path of agent

◆ release()

virtual void BluezQt::Agent::release ( )
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.

◆ requestAuthorization()

virtual void BluezQt::Agent::requestAuthorization ( DevicePtr  device,
const Request<> &  request 
)
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.

Parameters
devicedevice that invoked the action
requestrequest to be used for sending reply

◆ requestConfirmation()

virtual void BluezQt::Agent::requestConfirmation ( DevicePtr  device,
const QString &  passkey,
const Request<> &  request 
)
virtual

Requests the agent to confirm a passkey.

This method gets called when the Bluetooth daemon needs to confirm a passkey for an authentication.

Parameters
devicedevice that invoked the action
passkeypasskey to be confirmed
requestrequest to be used for sending reply

◆ requestPasskey()

virtual void BluezQt::Agent::requestPasskey ( DevicePtr  device,
const Request< quint32 > &  request 
)
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.

Parameters
devicedevice that invoked the action
requestrequest to be used for sending reply

◆ requestPinCode()

virtual void BluezQt::Agent::requestPinCode ( DevicePtr  device,
const Request< QString > &  request 
)
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.

Parameters
devicedevice that invoked the action
requestrequest to be used for sending reply