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.biometrics.ui.viewmodel
18 
19 /**
20  * A help, hint, or error message to show.
21  *
22  * These typically correspond to the same category of help/error callbacks from the underlying HAL
23  * that runs the biometric operation, but may be customized by the framework.
24  */
25 sealed interface PromptMessage {
26 
27     /** The message to show the user or the empty string. */
28     val message: String
29         get() =
30             when (this) {
31                 is Error -> errorMessage
32                 is Help -> helpMessage
33                 else -> ""
34             }
35 
36     /** If this is an [Error]. */
37     val isError: Boolean
38         get() = this is Error
39 
40     /** An error message. */
41     data class Error(val errorMessage: String) : PromptMessage
42 
43     /** A help message. */
44     data class Help(val helpMessage: String) : PromptMessage
45 
46     /** No message. */
47     object Empty : PromptMessage
48 }
49