#include <abstractpushprovider.h>

Inheritance diagram for KUnifiedPush::AbstractPushProvider:

[legend]

Public Types
enum	Error { NoError , ProviderRejected , TransientNetworkError }

Signals
void	clientRegistered (const KUnifiedPush::Client &client, KUnifiedPush::AbstractPushProvider::Error error=NoError, const QString &errorMsg={})

void	clientUnregistered (const KUnifiedPush::Client &client, KUnifiedPush::AbstractPushProvider::Error error=NoError)

void	connected ()

void	disconnected (KUnifiedPush::AbstractPushProvider::Error error, const QString &errorMsg={})

void	messageAcknowledged (const KUnifiedPush::Client &client, const QString &messageIdentifier)

void	messageReceived (const KUnifiedPush::Message &msg)

void	urgencyChanged ()

Public Member Functions
virtual void	acknowledgeMessage (const Client &client, const QString &messageIdentifier)

void	changeUrgency (Urgency urgency)

virtual void	connectToProvider (Urgency urgency)=0

virtual void	disconnectFromProvider ()=0

virtual bool	loadSettings (const QSettings &settings)=0

QLatin1StringView	providerId () const

virtual void	registerClient (const Client &client)=0

virtual void	resetSettings (QSettings &settings)

virtual void	unregisterClient (const Client &client)=0

Urgency	urgency () 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

Protected Member Functions
	AbstractPushProvider (QLatin1StringView providerId, QObject *parent)

virtual void	doChangeUrgency (Urgency urgency)

QNetworkAccessManager *	nam ()

void	setUrgency (Urgency urgency)

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)

Additional Inherited Members
Properties inherited from QObject
	objectName

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

Detailed Description

Base class for push provider protocol implementations.

Needed to support different push providers as that part of the protocol is not part of the UnifiedPush spec.

Definition at line 25 of file abstractpushprovider.h.

Member Enumeration Documentation

◆ Error

enum KUnifiedPush::AbstractPushProvider::Error

Enumerator
NoError	operation succeeded
ProviderRejected	communication worked, but the provider refused to complete the operation
TransientNetworkError	temporary network error, try again

Definition at line 31 of file abstractpushprovider.h.

Constructor & Destructor Documentation

◆ AbstractPushProvider()

AbstractPushProvider::AbstractPushProvider	(	QLatin1StringView	providerId,
		QObject *	parent )

explicitprotected

Definition at line 13 of file abstractpushprovider.cpp.

Member Function Documentation

◆ acknowledgeMessage()

void AbstractPushProvider::acknowledgeMessage	(	const Client &	client,
		const QString &	messageIdentifier )

virtual

Acknowledge a message.

The default implementation does nothing apart from indicating successful completion.

Reimplemented in KUnifiedPush::AutopushProvider, and KUnifiedPush::NextPushProvider.

Definition at line 25 of file abstractpushprovider.cpp.

◆ changeUrgency()

void AbstractPushProvider::changeUrgency ( Urgency urgency )

Change urgency level as needed.

Reimplement doChangeUrgency if your provider does this as a separate command.

Definition at line 30 of file abstractpushprovider.cpp.

◆ clientRegistered

void KUnifiedPush::AbstractPushProvider::clientRegistered	(	const KUnifiedPush::Client &	client,
		KUnifiedPush::AbstractPushProvider::Error	error = NoError,
		const QString &	errorMsg = {} )

signal

Emitted after successful client registration.

◆ clientUnregistered

void KUnifiedPush::AbstractPushProvider::clientUnregistered	(	const KUnifiedPush::Client &	client,
		KUnifiedPush::AbstractPushProvider::Error	error = NoError )

signal

Emitted after successful client unregistration.

◆ connected

void KUnifiedPush::AbstractPushProvider::connected ( )

signal

Emitted after the connection to the push provider has been established successfully.

◆ connectToProvider()

virtual void KUnifiedPush::AbstractPushProvider::connectToProvider ( Urgency urgency )

pure virtual

Attempt to establish a connection to the push provider.

Implemented in KUnifiedPush::AutopushProvider, KUnifiedPush::GotifyPushProvider, KUnifiedPush::NextPushProvider, and KUnifiedPush::NtfyPushProvider.

◆ disconnected

void KUnifiedPush::AbstractPushProvider::disconnected	(	KUnifiedPush::AbstractPushProvider::Error	error,
		const QString &	errorMsg = {} )

signal

Emitted after the connection to the push provider disconnected or failed to be established.

◆ disconnectFromProvider()

virtual void KUnifiedPush::AbstractPushProvider::disconnectFromProvider ( )

pure virtual

Disconnect and existing connection to the push provider.

Implemented in KUnifiedPush::AutopushProvider, KUnifiedPush::GotifyPushProvider, KUnifiedPush::NextPushProvider, and KUnifiedPush::NtfyPushProvider.

◆ doChangeUrgency()

void AbstractPushProvider::doChangeUrgency ( Urgency urgency )

protectedvirtual

Re-implement if urgency leve changes are done as a separate command.

The default implementation assumes urgency levels aren't supported by this provider.

Reimplemented in KUnifiedPush::AutopushProvider, and KUnifiedPush::NextPushProvider.

Definition at line 40 of file abstractpushprovider.cpp.

◆ loadSettings()

virtual bool KUnifiedPush::AbstractPushProvider::loadSettings ( const QSettings & settings )

pure virtual

Load connection settings.

Parameters

settings can be read on the top level, the correct group is already selected.

Returns: true if the settings are valid, false otherwise.

Implemented in KUnifiedPush::AutopushProvider, KUnifiedPush::GotifyPushProvider, KUnifiedPush::NextPushProvider, and KUnifiedPush::NtfyPushProvider.

◆ messageAcknowledged

void KUnifiedPush::AbstractPushProvider::messageAcknowledged	(	const KUnifiedPush::Client &	client,
		const QString &	messageIdentifier )

signal

Emitted after a message reception has been acknowledge to the push server.

◆ messageReceived

void KUnifiedPush::AbstractPushProvider::messageReceived ( const KUnifiedPush::Message & msg )

signal

Inform about a received push notification.

◆ nam()

QNetworkAccessManager * AbstractPushProvider::nam ( )

protected

Definition at line 56 of file abstractpushprovider.cpp.

◆ providerId()

QLatin1StringView AbstractPushProvider::providerId ( ) const

nodiscard

Provider id used e.g.

in settings.

Definition at line 46 of file abstractpushprovider.cpp.

◆ registerClient()

virtual void KUnifiedPush::AbstractPushProvider::registerClient ( const Client & client )

pure virtual

Register a new client with the provider.

Implemented in KUnifiedPush::AutopushProvider, KUnifiedPush::GotifyPushProvider, KUnifiedPush::NextPushProvider, and KUnifiedPush::NtfyPushProvider.

◆ resetSettings()

void AbstractPushProvider::resetSettings ( QSettings & settings )

virtual

Reset any internal state for a fresh setup connecting to a different push server instance.

The default implementation does nothing.

Reimplemented in KUnifiedPush::NextPushProvider, and KUnifiedPush::NtfyPushProvider.

Definition at line 21 of file abstractpushprovider.cpp.

◆ setUrgency()

void KUnifiedPush::AbstractPushProvider::setUrgency ( Urgency urgency )

inlineprotected

Definition at line 107 of file abstractpushprovider.h.

◆ unregisterClient()

virtual void KUnifiedPush::AbstractPushProvider::unregisterClient ( const Client & client )

pure virtual

Unregister a client from the provider.

Implemented in KUnifiedPush::AutopushProvider, KUnifiedPush::GotifyPushProvider, KUnifiedPush::NextPushProvider, and KUnifiedPush::NtfyPushProvider.

◆ urgency()

Urgency AbstractPushProvider::urgency ( ) const

nodiscard

The urgency level currently used by this provider.

This might not yet be the requested one if changing that is an asynchronous operation.

Definition at line 51 of file abstractpushprovider.cpp.

◆ urgencyChanged

void KUnifiedPush::AbstractPushProvider::urgencyChanged ( )

signal

Emitted when the urgency level change request has been executed.

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

Class Picker

Quick Links

About KUnifiedPush

KUnifiedPush::AbstractPushProvider

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Error

Constructor & Destructor Documentation

◆ AbstractPushProvider()

Member Function Documentation

◆ acknowledgeMessage()

◆ changeUrgency()

◆ clientRegistered

◆ clientUnregistered

◆ connected

◆ connectToProvider()

◆ disconnected

◆ disconnectFromProvider()

◆ doChangeUrgency()

◆ loadSettings()

◆ messageAcknowledged

◆ messageReceived

◆ nam()

◆ providerId()

◆ registerClient()

◆ resetSettings()

◆ setUrgency()

◆ unregisterClient()

◆ urgency()

◆ urgencyChanged