OneSignal-Android-SDK

OneSignal Android Push Notification Plugin

---

⚠️ Migration Advisory for current OneSignal customers

Our new user-centric APIs and v5.x.x SDKs offer an improved user and data management experience. However, they may not be at 1:1 feature parity with our previous versions yet.

If you are migrating an existing app, we suggest using Android’s Phased Rollout capabilities to ensure that there are no unexpected issues or edge cases. Here is the documentation for each:

Google Play Staged Rollouts

If you run into any challenges or have concerns, please contact our support team at [email protected]

---

OneSignal is a free email, sms, push notification, and in-app message service for mobile apps. This plugin makes it easy to integrate your native Android or Amazon app with OneSignal.

Installation

See OneSignal's Android Native SDK Setup Guide for documentation.

API

See OneSignal's Android Native SDK API page for a list of all available methods.

Change Log

See this repository's release tags for a complete change log of every released version.

Support

Please visit this repository's Github issue tracker for feature requests and bug reports related specifically to the SDK. For account issues and support please contact OneSignal support from the OneSignal.com dashboard.

Demo Project

To make things easier, we have published demo projects in the /Examples folder of this repository.

Building from source? This repository uses a git submodule for the shared Kotlin Multiplatform :logger module. Clone with git clone --recurse-submodules ..., or run git submodule update --init --recursive after cloning, before building. See CONTRIBUTING.md for details.

Supports:

• Tested from Android 5.0 (API level 21) to Android 14 (34)