KUnifiedPush::Connector

Search for usage in LXR

KUnifiedPush::Connector Class Reference

#include <connector.h>

Inheritance diagram for KUnifiedPush::Connector:

Public Types

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

Properties

QString endpoint
 
State state
 
- Properties inherited from QObject
 objectName
 

Signals

void endpointChanged (const QString &endpoint)
 
void messageReceived (const QByteArray &msg)
 
void stateChanged (KUnifiedPush::Connector::State state)
 

Public Member Functions

 Connector (const QString &serviceName, QObject *parent=nullptr)
 
QString endpoint () const
 
void registerClient (const QString &description)
 
State state () const
 
void unregisterClient ()
 
- 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
 

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)
 
QString trUtf8 (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
 
QObjectsender () 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 24 of file connector.h.

Member Enumeration Documentation

◆ 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 58 of file connector.h.

Constructor & Destructor Documentation

◆ Connector()

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

Create a new connector instance.

Parameters
serviceNameThe application identifier, same as used for registration on D-Bus and for D-Bus activation.

Definition at line 200 of file connector.cpp.

Member Function Documentation

◆ endpoint()

QString KUnifiedPush::Connector::endpoint ( ) const

HTTP endpoint to trigger the push notification.

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

See also
endpointChanged

◆ 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
descriptionA human-readable explanation what push notifications are used for by this application.

Definition at line 221 of file connector.cpp.

◆ state()

State KUnifiedPush::Connector::state ( ) const

State of the connector.

◆ 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 228 of file connector.cpp.


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 Sep 26 2022 03:53:48 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.