From 005db3dc88941159306fce5fcab8b4d77441bdd4 Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Wed, 10 Jan 2024 18:41:39 +0100 Subject: [PATCH] Move doc to Kdoc and fix formatting issue. --- .../android/appconfig/LockScreenConfig.kt | 34 ++++--------------- 1 file changed, 7 insertions(+), 27 deletions(-) diff --git a/appconfig/src/main/kotlin/io/element/android/appconfig/LockScreenConfig.kt b/appconfig/src/main/kotlin/io/element/android/appconfig/LockScreenConfig.kt index edeb0c0643..4d6b3a624c 100644 --- a/appconfig/src/main/kotlin/io/element/android/appconfig/LockScreenConfig.kt +++ b/appconfig/src/main/kotlin/io/element/android/appconfig/LockScreenConfig.kt @@ -25,41 +25,21 @@ import kotlin.time.Duration.Companion.seconds /** * Configuration for the lock screen feature. + * @property isPinMandatory Whether the PIN is mandatory or not. + * @property pinBlacklist Some PINs are forbidden. + * @property pinSize The size of the PIN. + * @property maxPinCodeAttemptsBeforeLogout Number of attempts before the user is logged out. + * @property gracePeriod Time period before locking the app once backgrounded. + * @property isStrongBiometricsEnabled Authentication with strong methods (fingerprint, some face/iris unlock implementations) is supported. + * @property isWeakBiometricsEnabled Authentication with weak methods (most face/iris unlock implementations) is supported. */ data class LockScreenConfig( - /** - * Whether the PIN is mandatory or not. - */ val isPinMandatory: Boolean, - - /** - * Some PINs are forbidden. - */ val pinBlacklist: Set, - - /** - * The size of the PIN. - */ val pinSize: Int, - - /** - * Number of attempts before the user is logged out. - */ val maxPinCodeAttemptsBeforeLogout: Int, - - /** - * Time period before locking the app once backgrounded. - */ val gracePeriod: Duration, - - /** - * Authentication with strong methods (fingerprint, some face/iris unlock implementations) is supported. - */ val isStrongBiometricsEnabled: Boolean, - - /** - * Authentication with weak methods (most face/iris unlock implementations) is supported. - */ val isWeakBiometricsEnabled: Boolean, )