UnifiedPush connector library

android unifiedpush

Kotlin 81.5%
Java 15.7%
Shell 1.7%
Starlark 0.6%
CSS 0.5%

Find a file

sim 0288a8294e All checks were successful ci/woodpecker/push/tests Pipeline was successful Details ci/woodpecker/push/main Pipeline was successful Details Fix formatting		2026-03-17 16:08:37 +01:00
.woodpecker	CI: UP-Ex now use .kts	2026-01-27 17:23:02 +01:00
connector	Fix formatting	2026-03-17 16:08:37 +01:00
dokka	Add kdoc documentation	2024-10-09 07:53:21 +00:00
gradle/wrapper	Bump dependencies	2025-09-27 08:39:23 +02:00
scripts	Tweak scripts/doc.sh	2026-03-13 12:13:35 +01:00
.gitignore	Add kdoc/ to .gitignore	2026-03-13 14:01:34 +01:00
.jitpack.yml	Bump java in .jitpack.yml	2023-09-05 23:50:26 +02:00
build.gradle	Bump kotlin to 2.3.0	2025-12-30 12:28:10 +01:00
Doc.md	Simplify sentence	2026-03-17 12:03:24 +01:00
gradle.properties	fix: typos and grammar (#27 )	2025-12-29 11:55:27 +01:00
gradlew	chore: update Gradle configuration	2024-08-11 14:39:10 +02:00
gradlew.bat	chore: update Gradle configuration	2024-08-11 14:39:10 +02:00
LICENSE	Update LICENSE	2021-01-26 20:54:56 +01:00
README.md	Remove line breaks in middle of sentences	2026-03-17 12:01:27 +01:00
settings.gradle	fix: Keep rootProject.name to Gradle approved characters	2024-08-09 17:36:43 +02:00

README.md

UnifiedPush android-connector

This library enables end user applications to easily integrate UnifiedPush. This library communicates with distributor apps and handles things such as registration, unregistration, and receiving push messages.

More formally, this library implements the end user application part of the UnifiedPush Android specification (so you don't have to).

Documentation

The example application shows the basic usage of this library.
The library documentation is available at https://unifiedpush.org/kdoc/.
General documentation is available at https://unifiedpush.org.

Building the documentation

Documentation for this library can be generated with Dokka:

./gradlew dokkaHtmlMultiModule

The result is available in the kdoc/ directory.

The scripts/doc.sh automates building the documentation for all UnifiedPush libraries.

./scripts/doc.sh

Funding

This project is funded through NGI Zero Core, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.