KUnifiedPush

UnifiedPush client library and distributor daemon.

Client Library

Getting Started

How to register for push notifications:

  • Register on D-Bus with a service name
  • Make your application D-Bus activatable
  • Create an instance of KUnifiedPush::Connector.
  • Communicate the endpoint URL provided by this to the corresponding server-side application.
  • Connect to its messageReceived signal.

Supported Distributors

For the basic functionality any standard compliant D-Bus distributor should work. The graphical status and configuration user interface however only works with the kunifiedpush-distributor, as that needs a lot more access to distributor internal details than the standard interfaces provide.

D-Bus Distributor

UnifiedPush only specifies the protocol between distributor and client as well as between the server-side application and the push provider, but not the one between the push provider and the distributor. Supporting different push providers therefore requires provider specific code and configuration.

Configuration

There is a configuration KCM, alternatively this can be configured via the ~/.config/KDE/kunifiedpush-distributor.conf configuration file.

[PushProvider]
Type=[Gotify|NextPush|Ntfy]

Supported push providers

Gotify

https://gotify.net/

Configuration:

[Gotify]
ClientToken=xxx
Url=https://my.server.org

NextPush

https://github.com/UP-NextPush/server-app

Configuration:

[NextPush]
AppPassword=xxx
Url=https://my.server.org
Username=user

Ntfy

https://ntfy.sh/

Configuration:

[Ntfy]
Url:https://ntfy.sh

Ntfy can be self-hosted, but also provides a hosted instance at https://ntfy.sh that works without requiring an account.

Push Notification KCM

In combination with our own distributor this allows configuring the push provider to use in System Settings, check the distributor status, and see all apps currently using push notifications.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Sep 30 2022 03:52:38 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.