Implemented dismiss functionality to cancel the scheduled alarm

MubarakNative · MubarakNative · commit 5f5536027e1b · 2024-04-28T19:09:31.000+05:30
diff --git a/.idea/deploymentTargetDropDown.xml b/.idea/deploymentTargetDropDown.xml
diff --git a/app/src/main/java/com/mbexample/alarmmanager/AlarmApp.kt b/app/src/main/java/com/mbexample/alarmmanager/AlarmApp.kt
@@ -4,6 +4,7 @@ import android.app.Application
 import android.app.NotificationChannel
 import android.app.NotificationManager
 import android.os.Build
+import com.mbexample.alarmmanager.utils.Constants.ALARM_CHANNEL_NAME
 import dagger.hilt.android.HiltAndroidApp
 
 @HiltAndroidApp
@@ -16,7 +17,7 @@ class AlarmApp: Application(){
             val name = getString(R.string.reminder)
             val channelDescription = getString(R.string.reminder_channel_desc)
             val importance = NotificationManager.IMPORTANCE_HIGH
-            val mChannel = NotificationChannel("AlarmChannel", name, importance)
+            val mChannel = NotificationChannel(ALARM_CHANNEL_NAME, name, importance)
             mChannel.description = channelDescription
             val notificationManager = getSystemService(NOTIFICATION_SERVICE) as NotificationManager
             notificationManager.createNotificationChannel(mChannel)
diff --git a/app/src/main/java/com/mbexample/alarmmanager/alarmmanager/AlarmSchedulerImpl.kt b/app/src/main/java/com/mbexample/alarmmanager/alarmmanager/AlarmSchedulerImpl.kt
@@ -7,6 +7,8 @@ import android.content.Intent
 import android.os.Build
 import com.mbexample.alarmmanager.data.sources.local.Alarm
 import com.mbexample.alarmmanager.receiver.AlarmReceiver
+import com.mbexample.alarmmanager.utils.Constants.MESSAGE
+import com.mbexample.alarmmanager.utils.Constants.TITLE
 
 class AlarmSchedulerImpl(private val context: Context) : AlarmScheduler {
 
@@ -16,10 +18,10 @@ class AlarmSchedulerImpl(private val context: Context) : AlarmScheduler {
 
         val pendingIntent = PendingIntent.getBroadcast(
             context,
-            alarm.id,
+            alarm.hashCode(),
             Intent(context, AlarmReceiver::class.java).apply {
-                putExtra("TITLE", alarm.title)
-                putExtra("MESSAGE", alarm.message)
+                putExtra(TITLE, alarm.title)
+                putExtra(MESSAGE, alarm.message)
             },
             PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT
         )
@@ -42,7 +44,7 @@ class AlarmSchedulerImpl(private val context: Context) : AlarmScheduler {
         alarmManager.cancel(
             PendingIntent.getBroadcast(
                 context,
-                alarm.id,
+                alarm.hashCode(),
                 Intent(context, AlarmReceiver::class.java),
                 PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT
             )
diff --git a/app/src/main/java/com/mbexample/alarmmanager/data/repository/AlarmRepository.kt b/app/src/main/java/com/mbexample/alarmmanager/data/repository/AlarmRepository.kt
@@ -9,6 +9,8 @@ interface AlarmRepository {
 
     suspend fun upsertAlarm(alarm: Alarm)
 
+    fun getAlarmById(alarmId: Long): Alarm
+
     fun getAllAlarm(): Flow<List<Alarm>>
 
     suspend fun deleteAlarm(alarm: Alarm)
diff --git a/app/src/main/java/com/mbexample/alarmmanager/data/repository/AlarmRepositoryImpl.kt b/app/src/main/java/com/mbexample/alarmmanager/data/repository/AlarmRepositoryImpl.kt
@@ -19,6 +19,10 @@ class AlarmRepositoryImpl @Inject constructor(
         alarmDatabase.getAlarmDao.upsertAlarm(alarm)
     }
 
+    override fun getAlarmById(alarmId: Long): Alarm {
+       return alarmDatabase.getAlarmDao.getAlarmById(alarmId)
+    }
+
     override fun getAllAlarm(): Flow<List<Alarm>> {
         return alarmDatabase.getAlarmDao.getAllAlarms()
     }
diff --git a/app/src/main/java/com/mbexample/alarmmanager/data/sources/local/Alarm.kt b/app/src/main/java/com/mbexample/alarmmanager/data/sources/local/Alarm.kt
@@ -7,7 +7,7 @@ import androidx.room.PrimaryKey
 data class Alarm(
 
     @PrimaryKey(true)
-    val id:Int,
+    var id:Long,
     val title: String,
     val message: String,
     val scheduleAt:Long
diff --git a/app/src/main/java/com/mbexample/alarmmanager/data/sources/local/AlarmDao.kt b/app/src/main/java/com/mbexample/alarmmanager/data/sources/local/AlarmDao.kt
@@ -20,6 +20,9 @@ interface AlarmDao {
     @Delete
     suspend fun deleteAlarm(alarm: Alarm)
 
+    @Query("SELECT * FROM Alarm WHERE id = :alarmId ")
+    fun getAlarmById(alarmId: Long): Alarm
+
     @Query("SELECT * FROM Alarm ORDER BY id DESC")
     fun getAllAlarms(): Flow<List<Alarm>>
 
diff --git a/app/src/main/java/com/mbexample/alarmmanager/data/sources/local/AlarmDatabase.kt b/app/src/main/java/com/mbexample/alarmmanager/data/sources/local/AlarmDatabase.kt
@@ -5,8 +5,7 @@ import androidx.room.RoomDatabase
 
 @Database(
     entities = [Alarm::class],
-    version = 1,
-    exportSchema = false
+    version = 1
 )
 abstract class AlarmDatabase: RoomDatabase() {
     abstract val getAlarmDao: AlarmDao
diff --git a/app/src/main/java/com/mbexample/alarmmanager/receiver/AlarmReceiver.kt b/app/src/main/java/com/mbexample/alarmmanager/receiver/AlarmReceiver.kt
@@ -5,27 +5,31 @@ import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
 import android.content.pm.PackageManager
+import android.icu.text.CaseMap.Title
 import android.widget.Toast
 import androidx.core.app.ActivityCompat
 import androidx.core.app.NotificationCompat
 import androidx.core.app.NotificationManagerCompat
 import com.mbexample.alarmmanager.R
 import com.mbexample.alarmmanager.ui.main.AlarmActivity
+import com.mbexample.alarmmanager.utils.Constants.ALARM_CHANNEL_NAME
+import com.mbexample.alarmmanager.utils.Constants.MESSAGE
+import com.mbexample.alarmmanager.utils.Constants.TITLE
 
 class AlarmReceiver : BroadcastReceiver() {
 
     override fun onReceive(context: Context?, intent: Intent?) {
 
-        val title = intent?.getStringExtra("TITLE") ?: return
-        val message = intent.getStringExtra("MESSAGE")
+        val title = intent?.getStringExtra(TITLE) ?: return
+        val message = intent.getStringExtra(MESSAGE)
 
         val goIntent = Intent(context, AlarmActivity::class.java).apply {
             flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
         }
         val pendingIntent: PendingIntent =
             PendingIntent.getActivity(context, 0, goIntent, PendingIntent.FLAG_IMMUTABLE)
 
-        val builder = NotificationCompat.Builder(context!!, "AlarmChannel")
+        val builder = NotificationCompat.Builder(context!!, ALARM_CHANNEL_NAME)
             .setSmallIcon(R.drawable.ic_launcher_foreground)
             .setContentTitle(title)
             .setContentText(message)
@@ -40,7 +44,5 @@ class AlarmReceiver : BroadcastReceiver() {
         ) {
             NotificationManagerCompat.from(context).notify(1, builder.build())
         }
-
-        Toast.makeText(context, "Alarm Triggered: $title\n$message", Toast.LENGTH_LONG).show()
     }
 }
diff --git a/app/src/main/java/com/mbexample/alarmmanager/ui/AlarmItemAdapter.kt b/app/src/main/java/com/mbexample/alarmmanager/ui/AlarmItemAdapter.kt
@@ -6,11 +6,15 @@ import androidx.core.view.isVisible
 import androidx.recyclerview.widget.DiffUtil
 import androidx.recyclerview.widget.ListAdapter
 import androidx.recyclerview.widget.RecyclerView
+import com.mbexample.alarmmanager.R
 import com.mbexample.alarmmanager.data.sources.local.Alarm
 import com.mbexample.alarmmanager.databinding.AlarmListItemBinding
+import com.mbexample.alarmmanager.utils.Event
 import java.text.DateFormat
 
-class AlarmItemAdapter: ListAdapter<Alarm, AlarmItemAdapter.HomeViewHolder>(diffCallBack) {
+class AlarmItemAdapter (
+    private val alarmItemDismissClickListener: AlarmItemDismissClickListener
+): ListAdapter<Alarm, AlarmItemAdapter.HomeViewHolder>(diffCallBack) {
 
     inner class HomeViewHolder(private val binding: AlarmListItemBinding) :
         RecyclerView.ViewHolder(binding.root) {
@@ -21,8 +25,11 @@ class AlarmItemAdapter: ListAdapter<Alarm, AlarmItemAdapter.HomeViewHolder>(diff
                 tvTitle.text = alarm.title
                 tvDesc.text = alarm.message
                 val df: DateFormat = DateFormat.getTimeInstance()
-                val formattedDate = df.format(alarm.scheduleAt)
-                tvAlarmTime.text = formattedDate
+                tvAlarmTime.text = df.format(alarm.scheduleAt)
+                btnDismiss.setOnClickListener {
+                    alarmItemDismissClickListener.onAlarmItemDismissClick(Event(Unit))
+                    tvAlarmTime.isEnabled = false
+                }
             }
         }
     }
@@ -50,6 +57,11 @@ class AlarmItemAdapter: ListAdapter<Alarm, AlarmItemAdapter.HomeViewHolder>(diff
         holder.bind(currentItem)
     }
 
+    interface AlarmItemDismissClickListener {
+        fun onAlarmItemDismissClick(alarm: Event<Unit>)
+
+    }
+
 }
 
 
diff --git a/app/src/main/java/com/mbexample/alarmmanager/ui/main/AlarmActivity.kt b/app/src/main/java/com/mbexample/alarmmanager/ui/main/AlarmActivity.kt
@@ -7,6 +7,7 @@ import android.os.Build
 import android.os.Bundle
 import android.provider.Settings
 import android.text.format.DateFormat
+import android.util.Log
 import android.widget.EditText
 import android.widget.Toast
 import androidx.activity.enableEdgeToEdge
@@ -41,15 +42,14 @@ class AlarmActivity : AppCompatActivity() {
     private lateinit var alarmSchedulerImpl: AlarmSchedulerImpl
     private var alarm: Alarm? = null
 
-
     @RequiresApi(Build.VERSION_CODES.TIRAMISU)
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         binding = ActivityAlarmBinding.inflate(layoutInflater)
         enableEdgeToEdge()
         setContentView(binding.root)
 
-        adapter = AlarmItemAdapter()
+        adapter = AlarmItemAdapter(viewModel)
         alarmSchedulerImpl = AlarmSchedulerImpl(this)
 
         ViewCompat.setOnApplyWindowInsetsListener(findViewById(R.id.main)) { v, insets ->
@@ -64,6 +64,12 @@ class AlarmActivity : AppCompatActivity() {
             adapter.submitList(it)
         }
 
+        viewModel.onAlarmDismissItemClick.observe(this) { onDismissClick ->
+            onDismissClick.getContentIfNotHandled()?.let {
+                alarm?.let(alarmSchedulerImpl::cancel)
+            }
+        }
+
         binding.alarmList.adapter = adapter
 
         binding.createAlarm.setOnClickListener {
@@ -76,7 +82,6 @@ class AlarmActivity : AppCompatActivity() {
                 )
             }
         }
-
     }
 
     private val activityResultLauncher = registerForActivityResult(
@@ -97,14 +102,13 @@ class AlarmActivity : AppCompatActivity() {
             R.string.pick_time
         ) { dialog, _ ->
 
-            val etTitle = view.findViewById<EditText>(R.id.tvTitle)
-            val etMsg = view.findViewById<EditText>(R.id.tvDesc)
+            val etTitle = view.findViewById<EditText>(R.id.etTitle)
+            val etMsg = view.findViewById<EditText>(R.id.etDesc)
 
             val title = etTitle.text.toString()
             val desc = etMsg.text.toString()
             if (title.isBlank() || desc.isBlank()) {
-                etTitle.error = "Field is required"
-                etMsg.error = "Field is required"
+                Toast.makeText(this, R.string.msg_missing_field, Toast.LENGTH_SHORT).show()
             } else {
                 openTimePicker(etTitle.text.toString(), etMsg.text.toString())
                 dialog.dismiss()
@@ -123,12 +127,12 @@ class AlarmActivity : AppCompatActivity() {
     private fun showEducationalDialog() {
         val dialog = MaterialAlertDialogBuilder(this)
             .setTitle(R.string.permission_denied)
-            .setMessage("To send a notification when alarm is triggered we need a permission")
-            .setNegativeButton("Close") { dialog, _ ->
+            .setMessage(R.string.request_msg)
+            .setNegativeButton(R.string.close) { dialog, _ ->
                 dialog.dismiss()
                 finish()
             }
-            .setPositiveButton("Settings") { dialog, _ ->
+            .setPositiveButton(R.string.settings) { dialog, _ ->
                 val intent = Intent(Settings.ACTION_APPLICATION_DETAILS_SETTINGS)
                 val uri = Uri.fromParts("package", packageName, null)
                 intent.setData(uri)
@@ -159,7 +163,6 @@ class AlarmActivity : AppCompatActivity() {
             .build()
 
         dialog.addOnPositiveButtonClickListener {
-            Toast.makeText(this, "${dialog.hour}:${dialog.minute}", Toast.LENGTH_LONG).show()
             createAlarm(title, message, dialog.hour, dialog.minute)
         }
         dialog.addOnNegativeButtonClickListener {
@@ -177,7 +180,7 @@ class AlarmActivity : AppCompatActivity() {
         calendar.set(Calendar.MINUTE, min)
         calendar.set(Calendar.SECOND, 0)
         alarm = Alarm(
-            0,
+            0L,
             title,
             message,
             calendar.timeInMillis
diff --git a/app/src/main/java/com/mbexample/alarmmanager/ui/main/AlarmActivityViewModel.kt b/app/src/main/java/com/mbexample/alarmmanager/ui/main/AlarmActivityViewModel.kt
@@ -1,22 +1,33 @@
 package com.mbexample.alarmmanager.ui.main
 
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.asLiveData
 import androidx.lifecycle.viewModelScope
 import com.mbexample.alarmmanager.data.repository.AlarmRepository
 import com.mbexample.alarmmanager.data.sources.local.Alarm
+import com.mbexample.alarmmanager.ui.AlarmItemAdapter
+import com.mbexample.alarmmanager.utils.Event
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 @HiltViewModel
 class AlarmActivityViewModel @Inject constructor(
     private val alarmRepository: AlarmRepository
-):ViewModel() {
+):ViewModel(),AlarmItemAdapter.AlarmItemDismissClickListener {
+
+    private val _onAlarmDismissItemClick = MutableLiveData<Event<Unit>>()
+    val onAlarmDismissItemClick: LiveData<Event<Unit>> = _onAlarmDismissItemClick
 
     fun insertAlarm(alarm: Alarm)= viewModelScope.launch{
         alarmRepository.insertAlarm(alarm)
     }
 
     val getAllAlarm = alarmRepository.getAllAlarm().asLiveData()
+
+    override fun onAlarmItemDismissClick(alarm: Event<Unit>) {
+        _onAlarmDismissItemClick.value = Event(Unit)
+    }
 }
diff --git a/app/src/main/java/com/mbexample/alarmmanager/utils/Constants.kt b/app/src/main/java/com/mbexample/alarmmanager/utils/Constants.kt
@@ -0,0 +1,8 @@
+package com.mbexample.alarmmanager.utils
+
+object Constants {
+    const val TITLE:String = "title extras"
+    const val MESSAGE:String = "message extras"
+
+    const val ALARM_CHANNEL_NAME = "alarm channel"
+}
diff --git a/app/src/main/java/com/mbexample/alarmmanager/utils/Event.kt b/app/src/main/java/com/mbexample/alarmmanager/utils/Event.kt
@@ -0,0 +1,22 @@
+package com.mbexample.alarmmanager.utils
+
+/**
+ * A wrapper class for livedata events
+ * used in [https://github.com/android/architecture-samples/]
+ * */
+ class Event<out T>(private val content: T) {
+
+    var hasBeenHandled = false
+        private set // Allow external read but not write
+
+    fun getContentIfNotHandled(): T? { // this function help to get the content
+        return if (hasBeenHandled) {
+           null
+        } else {
+            hasBeenHandled = true
+            content
+        }
+    }
+
+}
+
diff --git a/app/src/main/res/layout/alarm_list_item.xml b/app/src/main/res/layout/alarm_list_item.xml
@@ -10,6 +10,7 @@
         xmlns:tools="http://schemas.android.com/tools">
 
         <com.google.android.material.card.MaterialCardView
+            android:id="@+id/parentCard"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             style="?attr/materialCardViewFilledStyle"
@@ -60,8 +61,10 @@
                     android:textAppearance="@style/TextAppearance.AppCompat.Title"
                     app:layout_constraintBottom_toBottomOf="parent"
                     app:layout_constraintEnd_toStartOf="@+id/guideline2"
+                    app:layout_constraintHorizontal_bias="0.0"
                     app:layout_constraintStart_toStartOf="@+id/listParent"
                     app:layout_constraintTop_toBottomOf="@+id/tvAlarmTime"
+                    app:layout_constraintVertical_bias="0.16"
                     tools:text="Description" />
 
                 <Button
diff --git a/app/src/main/res/layout/dialog_create_alarm.xml b/app/src/main/res/layout/dialog_create_alarm.xml
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,10 @@ class AlarmRepositoryImpl @Inject constructor(`
`19`	`19`	`alarmDatabase.getAlarmDao.upsertAlarm(alarm)`
`20`	`20`	`}`
`21`	`21`
	`22`	`+ override fun getAlarmById(alarmId: Long): Alarm {`
	`23`	`+ return alarmDatabase.getAlarmDao.getAlarmById(alarmId)`
	`24`	`+ }`
	`25`	`+`
`22`	`26`	`override fun getAllAlarm(): Flow<List<Alarm>> {`
`23`	`27`	`return alarmDatabase.getAlarmDao.getAllAlarms()`
`24`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,7 @@ import androidx.room.RoomDatabase`
`5`	`5`
`6`	`6`	`@Database(`
`7`	`7`	`entities = [Alarm::class],`
`8`		`- version = 1,`
`9`		`- exportSchema = false`
	`8`	`+ version = 1`
`10`	`9`	`)`
`11`	`10`	`abstract class AlarmDatabase: RoomDatabase() {`
`12`	`11`	`abstract val getAlarmDao: AlarmDao`