#include <connector.h>

Inheritance diagram for KUnifiedPush::Connector:

Public Types
enum	State { Unregistered , Registering , Registered , NoDistributor , Error }

Properties
QString	endpoint

State	state

QString	vapidPublicKey

bool	vapidPublicKeyRequired

Properties inherited from QObject
	objectName

Signals
void	endpointChanged (const QString &endpoint)

void	messageReceived (const QByteArray &msg)

void	stateChanged (KUnifiedPush::Connector::State state)

void	vapidPublicKeyChanged ()

void	vapidPublicKeyRequiredChanged ()

Public Member Functions
	Connector (const QString &serviceName, QObject *parent=nullptr)

QByteArray	contentEncryptionAuthSecret () const

QByteArray	contentEncryptionPublicKey () const

QString	endpoint () const

void	registerClient (const QString &description)

void	setVapidPublicKey (const QString &vapidPublicKey)

void	setVapidPublicKeyRequired (bool vapidRequired)

State	state () const

void	unregisterClient ()

QString	vapidPublicKey () const

bool	vapidPublicKeyRequired () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Client connector to UnifiedPush.

Registers with a local UnifedPush distributor if present and obtains an endpoint that can be used for push notifications.

Definition at line 22 of file connector.h.

Member Enumeration Documentation

◆ State

enum KUnifiedPush::Connector::State

Connector state.

Enumerator
Unregistered	Connector is not yet registered, or explicitly unregistered.
Registering	Connector is registering with the push provider.
Registered	Connector is registered and thus operational.
NoDistributor	Connector cannot find a UnifiedPush distributor to register at.
Error	Any other error condition.

Definition at line 60 of file connector.h.

Property Documentation

◆ endpoint

QString KUnifiedPush::Connector::endpoint

read

Definition at line 25 of file connector.h.

◆ state

State KUnifiedPush::Connector::state

read

Definition at line 26 of file connector.h.

◆ vapidPublicKey

QString KUnifiedPush::Connector::vapidPublicKey

readwrite

Definition at line 27 of file connector.h.

◆ vapidPublicKeyRequired

bool KUnifiedPush::Connector::vapidPublicKeyRequired

readwrite

Definition at line 28 of file connector.h.

Constructor & Destructor Documentation

◆ Connector()

Connector::Connector	(	const QString &	serviceName,
		QObject *	parent = nullptr )

explicit

Create a new connector instance.

Parameters

serviceName The application identifier, same as used for registration on D-Bus and for D-Bus activation.

Definition at line 285 of file connector.cpp.

Member Function Documentation

◆ contentEncryptionAuthSecret()

QByteArray Connector::contentEncryptionAuthSecret ( ) const

nodiscard

Content encryption authentication secret.

When now key pair and authentication secret exist yet, a new one is generated and persisted.

When a key pair and authentication secret exists incoming messages are automatically decrypted.

Note: This returns the raw 16 byte key data, application server APIs typically want this in e.g. Base64 URL encoding.

See also: RFC 8291

Since: 25.08

Definition at line 370 of file connector.cpp.

◆ contentEncryptionPublicKey()

QByteArray Connector::contentEncryptionPublicKey ( ) const

nodiscard

Content encryption user agent public key.

When now key pair and authentication secret exist yet, a new one is generated and persisted.

When a key pair and authentication secret exists incoming messages are automatically decrypted.

Note: This returns the raw 65 byte key data, application server APIs typically want this in e.g. Base64 URL encoding.

See also: RFC 8291

Since: 25.08

Definition at line 364 of file connector.cpp.

◆ endpoint()

QString Connector::endpoint ( ) const

nodiscard

HTTP endpoint to trigger the push notification.

This needs to be communicated to the corresponding server-side application.

See also: endpointChanged

Definition at line 301 of file connector.cpp.

◆ endpointChanged

void KUnifiedPush::Connector::endpointChanged ( const QString & endpoint )

signal

Emitted when a new endpoint URL has been received.

◆ messageReceived

void KUnifiedPush::Connector::messageReceived ( const QByteArray & msg )

signal

Emitted for each newly received push message.

◆ registerClient()

void Connector::registerClient ( const QString & description )

Register this client.

This is for subscribing to push notifications and is only needed the first time an application uses this, or after explicitly unregistering. The registration is persisted until explicitly changed.

Parameters

description A human-readable explanation what push notifications are used for by this application.

See also: setVapidPublicKey

Definition at line 306 of file connector.cpp.

◆ setVapidPublicKey()

void Connector::setVapidPublicKey ( const QString & vapidPublicKey )

Sets the Voluntary Application Server Identification (VAPID) public key of the corresponding application.

This is a public key on the P-256 curve encoded in the uncompressed form and BASE64 URL encoded. This is used by the application server to identify itself to the push server, following RFC8292.

The VAPID public key is persisted, ie. you don't need to store it separately in the application.

Note: This should be either called before calling registerClient() or vapidPublicKeyRequired should be set to true.

See also: RFC 8292

Since: 25.08

Definition at line 329 of file connector.cpp.

◆ setVapidPublicKeyRequired()

void Connector::setVapidPublicKeyRequired ( bool vapidRequired )

Sets whether a Voluntary Application Server Identification (VAPID) public key is required before registering with the push provider.

When this is set, calling registerClient() will wait for a VAPID key to be set via setVapidPublicKey(). This is useful when the VAPID key has first to be retrieved asynchronously from the application server.

See also: setVapidPublicKey

Since: 25.08

Definition at line 353 of file connector.cpp.

◆ state()

Connector::State Connector::state ( ) const

nodiscard

State of the connector.

Definition at line 319 of file connector.cpp.

◆ stateChanged

void KUnifiedPush::Connector::stateChanged ( KUnifiedPush::Connector::State state )

signal

Emitted when the connector state changes.

◆ unregisterClient()

void Connector::unregisterClient ( )

Unregister this client.

This is for permanently unsubscribing, do not use on regular application shutdown.

Definition at line 313 of file connector.cpp.

◆ vapidPublicKey()

QString Connector::vapidPublicKey ( ) const

nodiscard

Returns the VAPID public key of the corresponding application.

See also: setVapidPublicKey

Since: 25.08

Definition at line 324 of file connector.cpp.

◆ vapidPublicKeyChanged

void KUnifiedPush::Connector::vapidPublicKeyChanged ( )

signal

Emitted when the VAPID public key changed.

Since: 25.08

◆ vapidPublicKeyRequired()

bool Connector::vapidPublicKeyRequired ( ) const

nodiscard

Returns whether a VAPID public key is required before registering with the push provider.

See also: setVapidPublicKeyRequired

Since: 25.08

Definition at line 348 of file connector.cpp.

◆ vapidPublicKeyRequiredChanged

void KUnifiedPush::Connector::vapidPublicKeyRequiredChanged ( )

signal

Emitted when the VAPID public key required property changed.

Since: 25.08

The documentation for this class was generated from the following files:

Class Picker

Quick Links

About KUnifiedPush

KUnifiedPush::Connector

Public Types

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ State

Property Documentation

◆ endpoint

◆ state

◆ vapidPublicKey

◆ vapidPublicKeyRequired

Constructor & Destructor Documentation

◆ Connector()

Member Function Documentation

◆ contentEncryptionAuthSecret()

◆ contentEncryptionPublicKey()

◆ endpoint()

◆ endpointChanged

◆ messageReceived

◆ registerClient()

◆ setVapidPublicKey()

◆ setVapidPublicKeyRequired()

◆ state()

◆ stateChanged

◆ unregisterClient()

◆ vapidPublicKey()

◆ vapidPublicKeyChanged

◆ vapidPublicKeyRequired()

◆ vapidPublicKeyRequiredChanged