KUnifiedPush::AbstractPushProvider

Search for usage in LXR

KUnifiedPush::AbstractPushProvider Class Referenceabstract

#include <abstractpushprovider.h>

Inheritance diagram for KUnifiedPush::AbstractPushProvider:

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 messageReceived (const KUnifiedPush::Message &msg)
 

Public Member Functions

virtual void connectToProvider ()=0
 
virtual void disconnectFromProvider ()=0
 
virtual bool loadSettings (const QSettings &settings)=0
 
const char * providerId () const
 
virtual void registerClient (const Client &client)=0
 
virtual void unregisterClient (const Client &client)=0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Member Functions

 AbstractPushProvider (const char *providerId, QObject *parent)
 
QNetworkAccessManagernam ()
 
- 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
 
QObjectsender () 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)
 
QString trUtf8 (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 23 of file abstractpushprovider.h.

Member Enumeration Documentation

◆ 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 29 of file abstractpushprovider.h.

Member Function Documentation

◆ 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 ( )
pure virtual

Attempt to establish a connection to the push provider.

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

◆ 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::NextPushProvider, KUnifiedPush::NtfyPushProvider, and KUnifiedPush::GotifyPushProvider.

◆ loadSettings()

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

Load connection settings.

Parameters
settingscan be read on the top level, the correct group is already selected.
Returns
true if the settings are valid, false otherwise.

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

◆ messageReceived

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

Inform about a received push notification.

◆ providerId()

const char * AbstractPushProvider::providerId ( ) const

Provider id used e.g.

in settings.

Definition at line 21 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::NextPushProvider, KUnifiedPush::NtfyPushProvider, and KUnifiedPush::GotifyPushProvider.

◆ unregisterClient()

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

Unregister a client from the provider.

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


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Aug 8 2022 03:53:38 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.