Icons are a way to provide a more unique, branded experience for your Android and Amazon app. Note that iOS doesn't support custom icons, as it uses the app icon for all notifications.
You may add a default icon that appears with every notification you send, or you may add icons to just certain types of notifications. The below tutorial shows you how to do both.
Android supports both Small and Large Notification Icons.
Small Notification Icons - by default our SDK automatically uses either a white bell icon or your App's launcher icon. Starting with Android 5, the OS forces Small Notification Icons to be all white when your app targets Android API 21+. If you don't make a correct icon, it will most likely be displayed as a bell or solid white icon in the status bar.
Large Notification Icons - The large notification icon will show up to the left of the notification text on Android 3.0+ devices. If you do not set a large icon, the small icon will be used instead. OneSignal will auto scale large notification icons for you to prevent the icon from being cropped.
We strongly recommend adding default icons to every Android and Amazon app.
To quickly and easily generate small icons with the correct settings, we recommend using the Android Asset Studio. Use
ic_stat_onesignal_default as the name.
If you prefer to create your own icons, you must make your icons the following size and colors:
Small Notification Icon (mdpi)
Small Notification Icon (hdpi)
Small Notification Icon (xhdpi)
Small Notification Icon (xxhdpi)
Large Notification Icon (xxxhdpi)
res/drawable-xxxhdpi/ (256x256) (Large Icon)
Assets/Plugins/Android/OneSignalConfig/res/drawable-xxxhdpi/ (256x256) (Large Icon)
PhoneGap, Cordova, Ionic
<project-root>/platforms/android/res/drawable-xxxhdpi/ (256x256) (Large Icon)
PhoneGap Build (PGB)
<project-root>/locales/android/drawable-xxxhdpi/ (256x256) (Large Icon)
See this github link for more details on the directory structure if you're having issues.
Limited, see this work around
Add files to root (all sizes)
Resources/drawable-xxxhdpi/ (256x256) (Large Icon)
Next, you must be sure the icon filenames are correct. If you used Android Asset Studio for your small icon then this step may have already been done for you.
PhoneGap, Cordova, Ionic,
PhoneGap Build (PGB), Xamarin
/drawable-xxxhdpi/ic_onesignal_large_icon_default.png (Large Icon)
<project-root>/resources/android/custom/ic_stat_onesignal_default (72x72) (small icon)
<project-root>/resources/android/custom/ic_onesignal_large_icon_default (256x256) (large icon)
ic_onesignal_large_icon_default.png (256x256)(Large Icon)
Done! You should be all set with your new default icons
After you've added your default icons, you may choose to add more non-default icons. These will let you show different icons depending on the types of notifications your app sends. For instance, a game with a title like "Jewel Breaker" may wish to have a different colored jewel icon for every notification sent that represents the player's level. Meanwhile, a social network may wish to show a chat bubble icon when the user receives a message from another user to differentiate those notifications from more generic system notifications.
OneSignal supports overriding default icons on a per-message basis.
Follow the steps above to generate icons and place them in the appropriate folder for your SDK.
To add non-default icons, you must name them something other than the default names specified above. For instance, you may name one
If you've followed the above steps for creating default icons, and have updated your app, you'll be able to reference those icons when you send a notification. To send a notification with an icon, within New Message open Android Options, and specify the icon to use.
Do not add the file extension when referencing the icon file. For instance, in the below example the file is referenced as
With Large Notification Icons, you can also supply a URL where the icon will be displayed from.
REST API - Instead of sending via the dashboard, you can send notifications with icons in the REST API by using the appropriate parameter and file extension depending on your platform (see more in Create notification REST API docs).
Android 5.0+ enforces your icon to only be white and transparent however it still allows tinting on the notification shown in the shade, known as the "accent color". (The status bar icon color will still be unaffected)
- To set a default color add the following line to your
<!-- Example: Sets all OneSignal notification's accent color to Green by default. --> <!-- Color format is in ARGB. --> <meta-data android:name="com.onesignal.NotificationAccentColor.DEFAULT" android:value="FF00FF00" />
- To set the color on per notification bases set
android_accent_coloron our Create notification API call. Or enter a value in the Accent color field under Options > Android on the New Message page on the OneSignal dashboard.
New icons take a while to propagate to all users
If you've very recently added an icon resource to your app, you may want to wait a few days before sending notifications using the icon. This is because it can take many days or even weeks for the majority of your users to update their apps to the latest version which contain your new icons.