How to solve this Targeting S+ (version 31 and above) requires that one of FLAG_IMMUTABLE or FLAG_MUTABLE

Question

Have been trying to solve this but couldn't . this is udacity lesson where i am trying to create notifications using pending intent but there is problem with Pending Intent being Mutable i tried with this way

ViewModel

private val REQUEST_CODE = 0
private val TRIGGER_TIME = "TRIGGER_AT"

private val minute: Long = 60_000L
private val second: Long = 1_000L

private val timerLengthOptions: IntArray
private val notifyPendingIntent: PendingIntent

private val alarmManager = app.getSystemService(Context.ALARM_SERVICE) as AlarmManager
private var prefs =
    app.getSharedPreferences("com.shivaConsulting.androidProjects.kotlinnotificatons", Context.MODE_PRIVATE)
private val notifyIntent = Intent(app, AlarmReciever::class.java)

private val _timeSelection = MutableLiveData<Int>()
val timeSelection: LiveData<Int>
    get() = _timeSelection

private val _elapsedTime = MutableLiveData<Long>()
val elapsedTime: LiveData<Long>
    get() = _elapsedTime

private var _alarmOn = MutableLiveData<Boolean>()
val isAlarmOn: LiveData<Boolean>
    get() = _alarmOn


private lateinit var timer: CountDownTimer


init {
    _alarmOn.value = PendingIntent.getBroadcast(
        getApplication(),
        REQUEST_CODE,
        notifyIntent,
        PendingIntent.FLAG_NO_CREATE
    ) != null

    notifyPendingIntent = PendingIntent.getBroadcast(
        getApplication(),
        REQUEST_CODE,
        notifyIntent,
        PendingIntent.FLAG_UPDATE_CURRENT
    )

    timerLengthOptions = app.resources.getIntArray(R.array.minutes_array)

    //If alarm is not null, resume the timer back for this alarm
    if (_alarmOn.value!!) {
        createTimer()
    }

}

/**
 * Turns on or off the alarm
 *
 * @param isChecked, alarm status to be set.
 */
fun setAlarm(isChecked: Boolean) {
    when (isChecked) {
        true -> timeSelection.value?.let { startTimer(it) }
        false -> cancelNotification()
    }
}

/**
 * Sets the desired interval for the alarm
 *
 * @param timerLengthSelection, interval timerLengthSelection value.
 */
fun setTimeSelected(timerLengthSelection: Int) {
    _timeSelection.value = timerLengthSelection
}

/**
 * Creates a new alarm, notification and timer
 */
private fun startTimer(timerLengthSelection: Int) {
    _alarmOn.value?.let {
        if (!it) {
            _alarmOn.value = true
            val selectedInterval = when (timerLengthSelection) {
                0 -> second * 10 //For testing only
                else ->timerLengthOptions[timerLengthSelection] * minute
            }
            val triggerTime = SystemClock.elapsedRealtime() + selectedInterval

            // TODO: Step 1.5 get an instance of NotificationManager and call sendNotification

            // TODO: Step 1.15 call cancel notification

            AlarmManagerCompat.setExactAndAllowWhileIdle(
                alarmManager,
                AlarmManager.ELAPSED_REALTIME_WAKEUP,
                triggerTime,
                notifyPendingIntent
            )

            viewModelScope.launch {
                saveTime(triggerTime)
            }
        }
    }
    createTimer()
}

/**
 * Creates a new timer
 */
private fun createTimer() {
    viewModelScope.launch {
        val triggerTime = loadTime()
        timer = object : CountDownTimer(triggerTime, second) {
            override fun onTick(millisUntilFinished: Long) {
                _elapsedTime.value = triggerTime - SystemClock.elapsedRealtime()
                if (_elapsedTime.value!! <= 0) {
                    resetTimer()
                }
            }

            override fun onFinish() {
                resetTimer()
            }
        }
        timer.start()
    }
}

/**
 * Cancels the alarm, notification and resets the timer
 */
private fun cancelNotification() {
    resetTimer()
    alarmManager.cancel(notifyPendingIntent)
}

/**
 * Resets the timer on screen and sets alarm value false
 */
private fun resetTimer() {
    timer.cancel()
    _elapsedTime.value = 0
    _alarmOn.value = false
}

private suspend fun saveTime(triggerTime: Long) =
    withContext(Dispatchers.IO) {
        prefs.edit().putLong(TRIGGER_TIME, triggerTime).apply()
    }

private suspend fun loadTime(): Long =
    withContext(Dispatchers.IO) {
        prefs.getLong(TRIGGER_TIME, 0)
    }'''

Fragment

class BlankFragment : Fragment() {

companion object {
    fun newInstance() = BlankFragment()
}
private val viewModel : BlankViewModel by lazy {
    ViewModelProvider(this).get(BlankViewModel::class.java)
}

override fun onCreateView(
    inflater: LayoutInflater, container: ViewGroup?,
    savedInstanceState: Bundle?
): View? {
    val binding = FragmentBlankBinding.inflate(inflater)
    binding.lifecycleOwner = this
    binding.blankViewModel = viewModel
  
    return binding.root
} '''

as i was looking into other similar questions which was solved by the gradle dependencies i have already added that

 implementation 'androidx.work:work-runtime-ktx:2.7.1'  

but showing this error

E/AndroidRuntime: Caused by: java.lang.IllegalArgumentException: com.shivaconsulting.kotlinnotifications: Targeting S+ (version 31 and above) requires that one of FLAG_IMMUTABLE or FLAG_MUTABLE be specified when creating a PendingIntent.
    Strongly consider using FLAG_IMMUTABLE, only use FLAG_MUTABLE if some functionality depends on the PendingIntent being mutable, e.g. if it needs to be used with inline replies or bubbles.
        at android.app.PendingIntent.checkFlags(PendingIntent.java:378)
        at android.app.PendingIntent.getBroadcastAsUser(PendingIntent.java:648)
        at android.app.PendingIntent.getBroadcast(PendingIntent.java:635)
        at com.shivaconsulting.kotlinnotifications.ui.BlankViewModel.<init>(BlankViewModel.kt:52)
            ... 44 more

Udacity Starter Code

Answer 1

Ref : https://developer.android.com/reference/android/app/PendingIntent#FLAG_MUTABLE

Flag indicating that the created PendingIntent should be mutable. This flag cannot be combined with FLAG_IMMUTABLE.

Up until Build.VERSION_CODES.R, PendingIntents are assumed to be mutable by default, unless FLAG_IMMUTABLE is set. Starting with Build.VERSION_CODES.S, it will be required to explicitly specify the mutability of PendingIntents on creation with either (@link #FLAG_IMMUTABLE} or FLAG_MUTABLE. It is strongly recommended to use FLAG_IMMUTABLE when creating a PendingIntent. FLAG_MUTABLE should only be used when some functionality relies on modifying the underlying intent, e.g. any PendingIntent that needs to be used with inline reply or bubbles.

    notifyPendingIntent = PendingIntent.getBroadcast(
            getApplication(),
            REQUEST_CODE,
            notifyIntent,
            PendingIntent.FLAG_UPDATE_CURRENT
        )

The code should be.

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
 notifyPendingIntent = PendingIntent.getBroadcast(
            getApplication(),
            REQUEST_CODE,
            notifyIntent,
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_MUTABLE
        )
    } else {
      notifyPendingIntent = PendingIntent.getBroadcast(
            getApplication(),
            REQUEST_CODE,
            notifyIntent,
            PendingIntent.FLAG_UPDATE_CURRENT
        )
    }

The same way you have to in

_alarmOn.value = PendingIntent.getBroadcast(
        getApplication(),
        REQUEST_CODE,
        notifyIntent,
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) PendingIntent.FLAG_NO_CREATE or PendingIntent.FLAG_MUTABLE else PendingIntent.FLAG_NO_CREATE
    ) != null

Edit 2

Also if you are not using PendingIntent and still having crash from system while using other components like MediaSessionCompat etc.

implementation 'androidx.work:work-runtime-ktx:RUNTIME-VERSION'

RUNTIME VERSION : https://developer.android.com/jetpack/androidx/releases/work