Refactor and add KDoc to MyCallReceiver

Author: adamff-dev

app/src/main/java/com/addev/listaspam/MyCallReceiver.kt

@@ -1,53 +1,62 @@
 package com.addev.listaspam
 
-import android.Manifest
 import android.annotation.SuppressLint
-import android.app.NotificationChannel
-import android.app.NotificationManager
 import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
-import android.content.pm.PackageManager
 import android.os.Build
 import android.telecom.TelecomManager
 import android.telephony.TelephonyManager
-import android.widget.Toast
 import androidx.annotation.RequiresApi
-import androidx.core.app.ActivityCompat
-import androidx.core.app.NotificationCompat
-import androidx.core.app.NotificationManagerCompat
-import okhttp3.*
-import org.jsoup.Jsoup
-import java.io.IOException
 
+/**
+ * BroadcastReceiver for handling incoming call events and checking for spam numbers.
+ * Requires Android P (API level 28) or higher.
+ *
+ * Note: This class will not work on Android Q (API level 29) or higher due to changes in privacy permissions.
+ * For Android Q or higher, use MyCallScreeningService instead.
+ */
+@RequiresApi(Build.VERSION_CODES.P)
 class MyCallReceiver : BroadcastReceiver() {
 
-    val spamUtils = SpamUtils()
+    private val spamUtils = SpamUtils()
 
-    @RequiresApi(Build.VERSION_CODES.P)
+    /**
+     * Called when the BroadcastReceiver is receiving an Intent broadcast.
+     * @param context Context for accessing resources.
+     * @param intent The received Intent.
+     */
     override fun onReceive(context: Context, intent: Intent) {
         if (intent.action == "android.intent.action.PHONE_STATE") {
             val state = intent.getStringExtra(TelephonyManager.EXTRA_STATE)
-            val incomingNumber =
-                intent.getStringExtra(TelephonyManager.EXTRA_INCOMING_NUMBER) ?: return
+            val incomingNumber = intent.getStringExtra(TelephonyManager.EXTRA_INCOMING_NUMBER) ?: return
 
             if (state == TelephonyManager.EXTRA_STATE_RINGING) {
-                incomingNumber?.let {
-                    spamUtils.checkSpamNumber(context, it) { isSpam ->
-                        if (isSpam) {
-                            endCall(context)
-                        }
-                    }
-                }
+                handleIncomingCall(context, incomingNumber)
             }
         }
     }
 
-    @RequiresApi(Build.VERSION_CODES.P)
+    /**
+     * Handles the incoming call by checking if the number is spam.
+     * @param context Context for accessing resources.
+     * @param incomingNumber The incoming phone number.
+     */
+    private fun handleIncomingCall(context: Context, incomingNumber: String) {
+        spamUtils.checkSpamNumber(context, incomingNumber) { isSpam ->
+            if (isSpam) {
+                endCall(context)
+            }
+        }
+    }
+
+    /**
+     * Ends the incoming call.
+     * @param context Context for accessing resources.
+     */
     @SuppressLint("MissingPermission")
     private fun endCall(context: Context) {
         val telMgr = context.getSystemService(Context.TELECOM_SERVICE) as TelecomManager
         telMgr.endCall()
     }
-
 }