Merge pull request #712 from android/tj/news-notifications
Notify users when news are updatedpull/691/merge
Adetunji Dahunsi
2 years ago
committed by
GitHub
commit
3b1b1ea4c1
@ -1,32 +0,0 @@
|
||||
/*
|
||||
* Copyright 2023 The Android Open Source Project
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.google.samples.apps.nowinandroid.core.notifications
|
||||
|
||||
import com.google.samples.apps.nowinandroid.core.model.data.NewsResource
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
/**
|
||||
* Implementation of [Notifier] that displays notifications in the system tray.
|
||||
*/
|
||||
@Singleton
|
||||
class AndroidSystemNotifier @Inject constructor() : Notifier {
|
||||
|
||||
override fun onNewsAdded(newsResources: List<NewsResource>) {
|
||||
// TODO, create notification and display to the user
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,176 @@
|
||||
/*
|
||||
* Copyright 2023 The Android Open Source Project
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.google.samples.apps.nowinandroid.core.notifications
|
||||
|
||||
import android.Manifest.permission
|
||||
import android.app.Notification
|
||||
import android.app.NotificationChannel
|
||||
import android.app.NotificationManager
|
||||
import android.app.PendingIntent
|
||||
import android.content.ComponentName
|
||||
import android.content.Context
|
||||
import android.content.Intent
|
||||
import android.content.pm.PackageManager
|
||||
import android.os.Build.VERSION
|
||||
import android.os.Build.VERSION_CODES
|
||||
import androidx.core.app.ActivityCompat
|
||||
import androidx.core.app.NotificationCompat
|
||||
import androidx.core.app.NotificationCompat.InboxStyle
|
||||
import androidx.core.app.NotificationManagerCompat
|
||||
import androidx.core.net.toUri
|
||||
import com.google.samples.apps.nowinandroid.core.model.data.NewsResource
|
||||
import dagger.hilt.android.qualifiers.ApplicationContext
|
||||
import javax.inject.Inject
|
||||
import javax.inject.Singleton
|
||||
|
||||
private const val MAX_NUM_NOTIFICATIONS = 5
|
||||
private const val TARGET_ACTIVITY_NAME = "com.google.samples.apps.nowinandroid.MainActivity"
|
||||
private const val NEWS_NOTIFICATION_REQUEST_CODE = 0
|
||||
private const val NEWS_NOTIFICATION_SUMMARY_ID = 1
|
||||
private const val NEWS_NOTIFICATION_CHANNEL_ID = ""
|
||||
private const val NEWS_NOTIFICATION_GROUP = "NEWS_NOTIFICATIONS"
|
||||
private const val DEEP_LINK_SCHEME_AND_HOST = "https://www.nowinandroid.apps.samples.google.com"
|
||||
private const val FOR_YOU_PATH = "foryou"
|
||||
|
||||
/**
|
||||
* Implementation of [Notifier] that displays notifications in the system tray.
|
||||
*/
|
||||
@Singleton
|
||||
class SystemTrayNotifier @Inject constructor(
|
||||
@ApplicationContext private val context: Context,
|
||||
) : Notifier {
|
||||
|
||||
override fun postNewsNotifications(
|
||||
newsResources: List<NewsResource>,
|
||||
) = with(context) {
|
||||
if (ActivityCompat.checkSelfPermission(
|
||||
this,
|
||||
permission.POST_NOTIFICATIONS,
|
||||
) != PackageManager.PERMISSION_GRANTED
|
||||
) {
|
||||
return
|
||||
}
|
||||
|
||||
val truncatedNewsResources = newsResources
|
||||
.take(MAX_NUM_NOTIFICATIONS)
|
||||
|
||||
val newsNotifications = truncatedNewsResources
|
||||
.map { newsResource ->
|
||||
createNewsNotification {
|
||||
setSmallIcon(
|
||||
com.google.samples.apps.nowinandroid.core.common.R.drawable.ic_nia_notification,
|
||||
)
|
||||
.setContentTitle(newsResource.title)
|
||||
.setContentText(newsResource.content)
|
||||
.setContentIntent(newsPendingIntent(newsResource))
|
||||
.setGroup(NEWS_NOTIFICATION_GROUP)
|
||||
.setAutoCancel(true)
|
||||
}
|
||||
}
|
||||
val summaryNotification = createNewsNotification {
|
||||
val title = getString(
|
||||
R.string.news_notification_group_summary,
|
||||
truncatedNewsResources.size,
|
||||
)
|
||||
setContentTitle(title)
|
||||
.setContentText(title)
|
||||
.setSmallIcon(
|
||||
com.google.samples.apps.nowinandroid.core.common.R.drawable.ic_nia_notification,
|
||||
)
|
||||
// Build summary info into InboxStyle template.
|
||||
.setStyle(newsNotificationStyle(truncatedNewsResources, title))
|
||||
.setGroup(NEWS_NOTIFICATION_GROUP)
|
||||
.setGroupSummary(true)
|
||||
.setAutoCancel(true)
|
||||
.build()
|
||||
}
|
||||
|
||||
// Send the notifications
|
||||
val notificationManager = NotificationManagerCompat.from(this)
|
||||
newsNotifications.forEachIndexed { index, notification ->
|
||||
notificationManager.notify(
|
||||
truncatedNewsResources[index].id.hashCode(),
|
||||
notification,
|
||||
)
|
||||
}
|
||||
notificationManager.notify(NEWS_NOTIFICATION_SUMMARY_ID, summaryNotification)
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an inbox style summary notification for news updates
|
||||
*/
|
||||
private fun newsNotificationStyle(
|
||||
newsResources: List<NewsResource>,
|
||||
title: String,
|
||||
): InboxStyle = newsResources
|
||||
.fold(InboxStyle()) { inboxStyle, newsResource ->
|
||||
inboxStyle.addLine(newsResource.title)
|
||||
}
|
||||
.setBigContentTitle(title)
|
||||
.setSummaryText(title)
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a notification for configured for news updates
|
||||
*/
|
||||
private fun Context.createNewsNotification(
|
||||
block: NotificationCompat.Builder.() -> Unit,
|
||||
): Notification {
|
||||
ensureNotificationChannelExists()
|
||||
return NotificationCompat.Builder(
|
||||
this,
|
||||
NEWS_NOTIFICATION_CHANNEL_ID,
|
||||
)
|
||||
.setPriority(NotificationCompat.PRIORITY_DEFAULT)
|
||||
.apply(block)
|
||||
.build()
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures the a notification channel is is present if applicable
|
||||
*/
|
||||
private fun Context.ensureNotificationChannelExists() {
|
||||
if (VERSION.SDK_INT < VERSION_CODES.O) return
|
||||
|
||||
val channel = NotificationChannel(
|
||||
NEWS_NOTIFICATION_CHANNEL_ID,
|
||||
getString(R.string.news_notification_channel_name),
|
||||
NotificationManager.IMPORTANCE_DEFAULT,
|
||||
).apply {
|
||||
description = getString(R.string.news_notification_channel_description)
|
||||
}
|
||||
// Register the channel with the system
|
||||
NotificationManagerCompat.from(this).createNotificationChannel(channel)
|
||||
}
|
||||
|
||||
private fun Context.newsPendingIntent(
|
||||
newsResource: NewsResource,
|
||||
): PendingIntent? = PendingIntent.getActivity(
|
||||
this,
|
||||
NEWS_NOTIFICATION_REQUEST_CODE,
|
||||
Intent().apply {
|
||||
action = Intent.ACTION_VIEW
|
||||
data = newsResource.newsDeepLinkUri()
|
||||
component = ComponentName(
|
||||
packageName,
|
||||
TARGET_ACTIVITY_NAME,
|
||||
)
|
||||
},
|
||||
PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
|
||||
)
|
||||
|
||||
private fun NewsResource.newsDeepLinkUri() = "$DEEP_LINK_SCHEME_AND_HOST/$FOR_YOU_PATH/$id".toUri()
|
||||
Loading…
Reference in new issue