KUnifiedPush::AbstractPushProvider
#include <abstractpushprovider.h>

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 |
![]() | |
QObject (QObject *parent) | |
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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
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 QRegExp ®Exp, 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 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_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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
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 | 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) |
QThread * | thread () const const |
Protected Member Functions | |
AbstractPushProvider (const char *providerId, QObject *parent) | |
QNetworkAccessManager * | nam () |
![]() | |
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 | |
![]() | |
objectName | |
![]() | |
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) |
![]() | |
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
|
signal |
Emitted after successful client registration.
◆ clientUnregistered
|
signal |
Emitted after successful client unregistration.
◆ connected
|
signal |
Emitted after the connection to the push provider has been established successfully.
◆ connectToProvider()
|
pure virtual |
Attempt to establish a connection to the push provider.
Implemented in KUnifiedPush::NextPushProvider, KUnifiedPush::NtfyPushProvider, and KUnifiedPush::GotifyPushProvider.
◆ disconnected
|
signal |
Emitted after the connection to the push provider disconnected or failed to be established.
◆ disconnectFromProvider()
|
pure virtual |
Disconnect and existing connection to the push provider.
Implemented in KUnifiedPush::NextPushProvider, KUnifiedPush::NtfyPushProvider, and KUnifiedPush::GotifyPushProvider.
◆ loadSettings()
|
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::NextPushProvider, KUnifiedPush::NtfyPushProvider, and KUnifiedPush::GotifyPushProvider.
◆ messageReceived
|
signal |
Inform about a received push notification.
◆ providerId()
const char * AbstractPushProvider::providerId | ( | ) | const |
◆ registerClient()
|
pure virtual |
Register a new client with the provider.
Implemented in KUnifiedPush::NextPushProvider, KUnifiedPush::NtfyPushProvider, and KUnifiedPush::GotifyPushProvider.
◆ unregisterClient()
|
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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Fri Sep 22 2023 03:50:15 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.