Android FAQ

Setting up ProGuard rules?

There is no need to set up ProGuard rules regarding the OpenBack SDK. These rules are set in the SDK and are included in your app upon building.

Can you read the notification payload information?

You can send extra information alongside the Dynamic Push payload which can then be read and used within your app.

My notification icon doesn't look right?

There can be different reasons for why your Android notification isn't appearing correctly.

To guarantee that your notification icon works across multiple versions of Android, the following checks must be made:

  • Make sure to add each size of icon.
  • Verify that the proper alpha channel is added.
  • Check that the icon transparency is properly set.
  • If the icon appears as a solid square, the icon image has been set correctly but was not generated with an appropriate transparency.
tip

We recommend using the Android Asset Studio to generate your app's notification icon.

Can I manually clear notifications?

Yes, you can manually clear notifications by using the standard APIs on the Android NotificationManager or Android NotificationManagerCompat classes.

Example
NotificationManagerCompat.from(context).cancelAll();

How large is the Android SDK?

The SDK is very lightweight and is a ~230kB AAR file.

Does OpenBack work without Firebase Cloud Messaging?

While it's recommended that you use FCM, the OpenBack SDK still functions normally without it. The SDK periodically pulls down the latest messages based on the Sync Frequency that is set in your App Settings page. The messages are then cached to each users device and are ready to deliver at the perfect moment.

Already using a 3rd party plugin that includes push?

If you're already using a 3rd party plugin that offers push notifications, it's important to see if the plugin is setting a priority level. OpenBack is built to work seamlessly with all other plugins but we've found that some plugins will set a large priority value for their Android notifications. Simply set a higher priority level for the OpenBack messaging service.

Using the KeyChain API?

If your app uses the KeyChain API, ensure that you get a valid response before running any important checks as a locked device can't access KeyChain data. Silent push notifications and scheduled alarms within the OpenBack SDK will briefly open your app in the background. This happens whether the device is locked or unlocked.

How does the Brightness signal work?

The Brightness signal delivers messages to the user based on the ambient light around the phone. This value is measured in SI lux units.

Why can I see 404 responses in the Firebase Network Monitor?

If your app uses the Firebase Network Monitor or similar tools, you may see it tracking 404 responses from the OpenBack SDK. This is normal behavior and is due to the SDK checking to see if specific message files are present. If those files aren't required or available, this can be logged as a 404, as the resources don't exist.

Using the Sync Frequency settings in the dashboard, the app checks for the latest content & settings updates from the OpenBack platform. The SDK checks for 3 main content & settings files:

  1. Global message campaigns
  2. Messages just for that user (e.g., sent via the OpenBack API to a specific user identity)
  3. Messages with multiple languages.

If your implementation of OpenBack doesn't use 2) or 3), there won't any data available which will result in 66% of the OpenBack network requests returning a 404 response. Please contact us if you would like any further details.

How do I send images in a push notification?

You can easily add an image in step 2 of the message creation. An image can be sent as part of an in-app message or as a piece of rich notification content. To send an image, you must include a URL that ends with .png/.jpg/.jpeg such as "https://icatcare.org/app/uploads/2018/07/Thinking-of-getting-a-cat.png". You cannot use Google Drive, Dropbox or similar hosting services to send an image as the SDK needs to be able to download the image.

How do I send videos in a push notification?

You can easily add a video in step 2 of the message creation and it is sent as part of an in-app message. To send a video, you must include a URL that ends with .mp4/.avi such as "https://www.w3schools.com/html/movie.mp4". You cannot use Google Drive, YouTube or similar hosting services to send a video as the SDK needs to be able to download the video to deliver the message.

Can I deep link to the notification settings?

You may want to link a user to the notification settings for your app in the case that they have blocked notifications. To do this you can use the sample code below:

Intent intent = new Intent();
intent.setAction("android.settings.APP_NOTIFICATION_SETTINGS");
//for Android 5-7
intent.putExtra("app_package", getPackageName());
intent.putExtra("app_uid", getApplicationInfo().uid);
// for Android 8 and above
intent.putExtra("android.provider.extra.APP_PACKAGE", getPackageName());
startActivity(intent);