Required For Setup
- A OneSignal Account if you do not already have one
- Your OneSignal App ID, available in Keys & IDs
- A Google Server API Key. Follow instructions to generate one here
- A device or emulator that has Google Play services installed and updated on it - push notifications will not be received without these.
- A computer running Android Studio (these instructions work for both Android and Amazon projects using Android Studio). If you're using Eclipse, follow this guide instead.
1. Gradle Setup
1.1 Open your build.gradle (Module: app) file and add the following to your dependencies.
dependencies {
compile 'com.onesignal:OneSignal:[3.6.0, 3.99.99]'
}Automatic Dependencies
OneSignal automatically adds the following dependencies;
com.google.android.gms- Version 11com.android.support- Version 26
Please makes sure your project matches these versions if you run into a mismatch version error.
For more details see the All gms/firesbase libraries must use the exact same version specification section.
1.2 In the same build.gradle file, add the following in your android > defaultConfig section.
- Update
PUT YOUR ONESIGNAL APP ID HEREwith your OneSignal app id
android {
defaultConfig {
manifestPlaceholders = [onesignal_app_id: "PUT YOUR ONESIGNAL APP ID HERE",
// Project number pulled from dashboard, local value is ignored.
onesignal_google_project_number: "REMOTE"]
}
}
import com.onesignal.OneSignal;
public class YourAppClass extends Application {
public void onCreate() {
super.onCreate();
OneSignal.startInit(this)
.inFocusDisplaying(OneSignal.OSInFocusDisplayOption.Notification)
.unsubscribeWhenNotificationsAreDisabled(true)
.init();
// Call syncHashedEmail anywhere in your app if you have the user's email.
// This improves the effectiveness of OneSignal's "best-time" notification scheduling feature.
// OneSignal.syncHashedEmail(userEmail);
}
}Don't have a class that extends Application in your project?
Follow this tutorial to create one.
3. Create a default notification icon
3.1 Starting with Android Lollipop 5.0 a small notification icon is required for the icon to be visible in the status bar. Follow the Customize Notification Icons instructions to create a small notification icon.
Troubleshooting
If run into any issues please see our Android troubleshooting guide, or our general Troubleshooting section.
- For a full example, see our example projects on Github.
You're Done!
Next up: Send your first push notification via the OneSignal Dashboard
Notification Features
To configure notifications features, go to Features Setup.
Notification Handlers
NotificationOpenedHandler - This will be called when a notification is tapped on.
See our setNotificationOpenedHandler documentation to add one.
NotificationReceivedHandler - This will be called when a notification is received.
See our setNotificationReceivedHandler documentation to add one.
NotificationExtenderService - This service can be setup to receive notifications no matter if your app is running or not. It can be used override how notifications are shown in the notification shade or to process data silently without showing a notification. See the Background Data and Notification Overriding section to set this up.