Skip to content

[MOB-5406] create notification channel for each sound #488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Jan 30, 2023
Merged

[MOB-5406] create notification channel for each sound #488

Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
ce6481b
sets up channel id and channel name for each unique sound
evantk91 Jan 15, 2023
2b46fce
adds conditionals for default channel creation
evantk91 Jan 15, 2023
a82463a
investigating edge cases
evantk91 Jan 15, 2023
0050972
debugging
evantk91 Jan 15, 2023
9d7afa1
adds default sounds for edge cases
evantk91 Jan 15, 2023
ddcc311
adds default channel id and channel name for edge cases
evantk91 Jan 16, 2023
4e46650
minor edits
evantk91 Jan 16, 2023
ba4355b
minor edits
evantk91 Jan 16, 2023
bfc2e78
cleans up conditionals
evantk91 Jan 16, 2023
0cc6c66
adds import for IterableNotificationTest
evantk91 Jan 16, 2023
75c201e
reorganizes and checks resources folder for matching sound file
evantk91 Jan 17, 2023
54d29b4
minor edits
evantk91 Jan 17, 2023
9b34e26
minor edits
evantk91 Jan 17, 2023
a272eae
minor edits
evantk91 Jan 17, 2023
20ea6c3
updates channel names to sound names
evantk91 Jan 17, 2023
7f9ac07
resolves null pointer exception for soundName
evantk91 Jan 20, 2023
f4138b7
removes unneccessary package from build.gradle
evantk91 Jan 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 41 additions & 46 deletions iterableapi/src/main/java/com/iterable/iterableapi/IterableNotificationHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import android.net.Uri;
import android.os.Build;
import android.os.Bundle;
import android.provider.Settings;
import android.service.notification.StatusBarNotification;

import androidx.annotation.VisibleForTesting;
Expand Down Expand Up @@ -102,8 +103,8 @@ public IterableNotificationBuilder createNotification(Context context, Bundle ex
String soundName = null;
String messageId = null;
String pushImage = null;
int soundResourceId = 0;
//TODO: When backend supports channels, these strings needs to change (channelName, channelId, channelDescription).
String channelName = getChannelName(context);
String channelDescription = "";

if (!extras.containsKey(IterableConstants.ITERABLE_DATA_KEY)) {
Expand All @@ -116,12 +117,20 @@ public IterableNotificationBuilder createNotification(Context context, Bundle ex
return null;
}

IterableNotificationBuilder notificationBuilder = new IterableNotificationBuilder(context, getChannelId(context));
JSONObject iterableJson = null;
title = extras.getString(IterableConstants.ITERABLE_DATA_TITLE, applicationName);
notificationBody = extras.getString(IterableConstants.ITERABLE_DATA_BODY);
soundName = extras.getString(IterableConstants.ITERABLE_DATA_SOUND);

if (soundName != null && soundName.contains(".") && soundName.charAt(0) != '.') {
String[] soundFile = soundName.split("\\.");
soundName = soundFile[0];
soundResourceId = context.getResources().getIdentifier(soundFile[0], "raw", context.getPackageName());
}

String channelName = getChannelName(context, soundName, soundResourceId);
IterableNotificationBuilder notificationBuilder = new IterableNotificationBuilder(context, getChannelId(context, soundName, soundResourceId));

String iterableData = extras.getString(IterableConstants.ITERABLE_DATA_KEY);

try {
Expand Down Expand Up @@ -205,8 +214,8 @@ public IterableNotificationBuilder createNotification(Context context, Bundle ex

notificationBuilder.setDefaults(notifPermissions.defaults);

removeUnusedChannel(context);
registerChannelIfEmpty(context, getChannelId(context), channelName, channelDescription, soundName);
removeUnusedChannel(context, soundName, soundResourceId);
registerChannelIfEmpty(context, getChannelId(context, soundName, soundResourceId), channelName, channelDescription, soundName, soundResourceId);

return notificationBuilder;
}
Expand Down Expand Up @@ -240,7 +249,7 @@ public void postNotificationOnDevice(Context context, IterableNotificationBuilde
* @param channelName Sets the channel name that is shown to the user.
* @param channelDescription Sets the channel description that is shown to the user.
*/
private void registerChannelIfEmpty(Context context, String channelId, String channelName, String channelDescription, String soundName) {
private void registerChannelIfEmpty(Context context, String channelId, String channelName, String channelDescription, String soundName, int soundResourceId) {
NotificationManager mNotificationManager = (NotificationManager)
context.getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE);
if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O
Expand All @@ -249,21 +258,21 @@ private void registerChannelIfEmpty(Context context, String channelId, String ch
if (existingChannel == null || !existingChannel.getName().equals(channelName)) {
IterableLogger.d(IterableNotificationBuilder.TAG, "Creating notification: channelId = " + channelId + " channelName = "
+ channelName + " channelDescription = " + channelDescription);
mNotificationManager.createNotificationChannel(createNotificationChannel(channelId, channelName, channelDescription, context, soundName));
mNotificationManager.createNotificationChannel(createNotificationChannel(channelId, channelName, channelDescription, context, soundName, soundResourceId));
}
}
}

/**
* Safely removes unused and old channel if the configuration for notification badge is changed.
*/
private void removeUnusedChannel(Context context) {
private void removeUnusedChannel(Context context, String soundName, int soundResourceId) {
NotificationManager mNotificationManager = (NotificationManager)
context.getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE);

if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O
&& mNotificationManager != null) {
String channelIdToDelete = getOldChannelId(context);
String channelIdToDelete = getOldChannelId(context, soundName, soundResourceId);
NotificationChannel unusedChannel = mNotificationManager.getNotificationChannel(channelIdToDelete);
if (unusedChannel != null) {
for (StatusBarNotification activeNotification : mNotificationManager.getActiveNotifications()) {
Expand All @@ -277,12 +286,12 @@ private void removeUnusedChannel(Context context) {
}
}

private NotificationChannel createNotificationChannel(String channelId, String channelName, String channelDescription, Context context, String soundName) {
private NotificationChannel createNotificationChannel(String channelId, String channelName, String channelDescription, Context context, String soundName, int soundResourceId) {
NotificationChannel notificationChannel = null;
Uri soundUri = null;
AudioAttributes audioAttributes = null;

soundUri = getSoundUri(context, soundName, soundUri);
soundUri = getSoundUri(context, soundName, soundResourceId);
audioAttributes = getAudioAttributes(audioAttributes);

if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
Expand All @@ -292,6 +301,7 @@ private NotificationChannel createNotificationChannel(String channelId, String c
notificationChannel.setShowBadge(isNotificationBadgingEnabled(context));
notificationChannel.setSound(soundUri, audioAttributes);
}

return notificationChannel;
}

Expand All @@ -307,16 +317,21 @@ private static boolean isNotificationBadgingEnabled(Context context) {
return true;
}

private String getChannelId(Context context) {
return getChannelIdName(context, true);
private String getChannelId(Context context, String soundName, int soundResourceId) {
return getChannelIdName(context, true, soundName, soundResourceId);
}

private String getOldChannelId(Context context) {
return getChannelIdName(context, false);
private String getOldChannelId(Context context, String soundName, int soundResourceId) {
return getChannelIdName(context, false, soundName, soundResourceId);
}

private String getChannelIdName(Context context, boolean isActive) {
private String getChannelIdName(Context context, boolean isActive, String soundName, int soundResourceId) {
String channelId = context.getPackageName();

if (soundResourceId != 0) {
channelId = soundName;
}

if (isActive) {
if (!isNotificationBadgingEnabled(context)) {
channelId = channelId + NO_BADGE;
Expand All @@ -329,26 +344,11 @@ private String getChannelIdName(Context context, boolean isActive) {
return channelId;
}

private String getChannelName(Context context) {
String channelName = null;
try {
ApplicationInfo info = context.getPackageManager().getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
if (info.metaData != null) {
Object channelNameMetaData = info.metaData.get(IterableConstants.NOTIFICATION_CHANNEL_NAME);
if (channelNameMetaData instanceof String) {
// Literal string value
channelName = (String) channelNameMetaData;
} else if (channelNameMetaData instanceof Integer) {
// Try to read from a string resource
int stringId = (Integer) channelNameMetaData;
if (stringId != 0) {
channelName = context.getString(stringId);
}
}
IterableLogger.d(IterableNotificationBuilder.TAG, "channel name: " + channelName);
}
} catch (Exception e) {
IterableLogger.e(IterableNotificationBuilder.TAG, "Error while retrieving channel name", e);
private String getChannelName(Context context, String soundName, int soundResourceId) {
String channelName = "Default";

if (soundResourceId != 0) {
channelName = soundName;
}

if (channelName != null) {
Expand Down Expand Up @@ -436,18 +436,13 @@ private static AudioAttributes getAudioAttributes(AudioAttributes audioAttribute
return audioAttributes;
}

private static Uri getSoundUri(Context context, String soundName, Uri soundUri) {
if (soundName != null) {
//Removes the file type from the name
String[] soundFile = soundName.split("\\.");
soundName = soundFile[0];

if (!soundName.equalsIgnoreCase(IterableConstants.DEFAULT_SOUND)) {
int soundID = context.getResources().getIdentifier(soundName, IterableConstants.SOUND_FOLDER_IDENTIFIER, context.getPackageName());
soundUri = Uri.parse(IterableConstants.ANDROID_RESOURCE_PATH + context.getPackageName() + "/" + soundID);
}
private static Uri getSoundUri(Context context, String soundName, int soundResourceId) {
if (soundResourceId == 0 || soundName == null) {
return Settings.System.DEFAULT_NOTIFICATION_URI;
}
return soundUri;

int soundID = context.getResources().getIdentifier(soundName, IterableConstants.SOUND_FOLDER_IDENTIFIER, context.getPackageName());
return Uri.parse(IterableConstants.ANDROID_RESOURCE_PATH + context.getPackageName() + "/" + soundID);
}

}