Quickstart   •   Website   •   Docs   •   Examples

OneSignal Android Sample

OneSignal makes engaging customers simple and is the fastest, most reliable service to send push notifications, in-app messages, SMS, and emails.

This project demonstrates integrating the OneSignal SDK into an Android project built with Kotlin. You can use this project as a boilerplate or reference to start your project.

🚦 Getting started

This project assumes that you already have a OneSignal app created with push notifications setup. If you don't yet have a OneSignal app, create one first, then follow the steps below to integrate the OneSignal SDK into your Android or iOS app.

Requirements

• Android Studio Chipmunk.
• OneSignal account and project.
• Firebase Server Key.
• Physical or virtual device.

Usage

To test this example, clone this repository as follows:

git clone https://github.com/OneSignalDevelopers/OneSignal-Android-Push-Sample

In Android Studio:

1. Open the project.
2. Click the green play icon to run the app.

Initialize OneSignal

onesignal-android-sample/app/src/main/java/com/onesignal/sample/android/MainApplication.kt

Lines 8 to 14 in 3e5493f

	class MainApplication : Application() {
	override fun onCreate() {
	super.onCreate()
	OneSignal.Debug.logLevel = LogLevel.VERBOSE
	OneSignal.initWithContext(this, ONESIGNAL_APP_ID)
	}
	}

Enable push subscription

onesignal-android-sample/app/src/main/java/com/onesignal/sample/android/MainActivity.kt

Lines 21 to 23 in 3e5493f

	findViewById<Button>(R.id.enable_push).setOnClickListener {
	OneSignal.User.pushSubscription.optIn()
	}

Send push notification

## Send notification
# https://documentation.onesignal.com/reference/create-notification
curl -X "POST" "http://notifications" \
    -H 'Content-Type: application/json' \
    -u '<Your REST API Key>:' \
    -d $'{
  "headings": {
    "en": "🥳🍾🎊"
  },
  "included_segments": [
    "Subscribed Users"
  ],
  "app_id": "<Your APP ID>",
  "contents": {
    "en": "You recieved your first push!"
  },
  "url": "https://onesignal.com"
}'

Trigger In-App Message

1. Create a new In-App Message

Navigate to Messages and select In-App from the submenu...

Choose New Message button...

Choose New In-App from the dropdown.

2. Configure In-App Message

Name the In-App Message "Sample IAM"...

Configure the In-App Message to be presented to All Users...

Use the block editor to create the content of your In-App Message...

Configure the In-App Message to trigger when a certain condition is met i.e., show_sample_iam is 1...

Schedule the In-App Message to be presented immediately, to show until dismissed by the user, and to present itself everytime the trigger contions is met. Then choose Make Message Live...

Review configuration and confirm when correct.

3. Launch In-App Message

Tap the Present In-App Message button in the sample app to present In-App Message.

Support

Ask a question about OneSignal

You can ask questions about the OneSignal xxx SDK and related topics in the onesignal-xxx-sdk repository.

🙋‍♂️ Ask a question

Create a bug report

If you receive an error message or get blocked by an issue, please create a bug report!

🪳 Create bug report

❤️ Developer Community

For additional resources, please join the OneSignal Developer Community.

Get in touch with us or learn more about OneSignal through the channels below.

• Follow us on Twitter to never miss any updates from the OneSignal team, ecosystem & community
• Join us on Discord to be a part of the OneSignal Developers community, showcase your work and connect with other OneSignal developers
• Read the OneSignal Blog for the latest announcements, tutorials, in-depth articles & more.
• Subscribe to us on YouTube for walkthroughs, courses, talks, workshops & more.
• Follow us on Twitch for live streams, office hours, support & more.

Show your support

Give a ⭐️ if this project helped you, and watch this repo to stay up to date.