1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.systemui.bouncer.ui.viewmodel
18 
19 import kotlinx.coroutines.flow.MutableStateFlow
20 import kotlinx.coroutines.flow.StateFlow
21 import kotlinx.coroutines.flow.asStateFlow
22 
23 sealed class AuthMethodBouncerViewModel(
24     /**
25      * Whether user input is enabled.
26      *
27      * If `false`, user input should be completely ignored in the UI as the user is "locked out" of
28      * being able to attempt to unlock the device.
29      */
30     val isInputEnabled: StateFlow<Boolean>,
31 ) {
32 
33     private val _animateFailure = MutableStateFlow(false)
34     /**
35      * Whether a failure animation should be shown. Once consumed, the UI must call
36      * [onFailureAnimationShown] to consume this state.
37      */
38     val animateFailure: StateFlow<Boolean> = _animateFailure.asStateFlow()
39 
40     /**
41      * Notifies that the failure animation has been shown. This should be called to consume a `true`
42      * value in [animateFailure].
43      */
44     fun onFailureAnimationShown() {
45         _animateFailure.value = false
46     }
47 
48     /** Ask the UI to show the failure animation. */
49     protected fun showFailureAnimation() {
50         _animateFailure.value = true
51     }
52 }
53