Files
letro-ios/ElementX/Sources/Screens/AppLock/AppLockSetupPINScreen/AppLockSetupPINScreenModels.swift

98 lines
3.3 KiB
Swift

//
// Copyright 2022 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import Foundation
enum AppLockSetupPINScreenViewModelAction {
/// The user succeeded PIN entry.
case complete
/// The user cancelled PIN entry.
case cancel
/// The user failed to remember their PIN to unlock.
case forceLogout
}
enum AppLockSetupPINScreenMode {
/// Creating a new PIN.
case create
/// Confirming the new PIN.
case confirm
/// Unlocking with the current PIN.
case unlock
}
struct AppLockSetupPINScreenViewState: BindableState {
/// The number of attempts allowed to enter the PIN.
let maximumAttempts = 3
/// The current mode that the screen is in.
var mode: AppLockSetupPINScreenMode
/// Whether the screen is mandatory or can be cancelled.
let isMandatory: Bool
/// The number of attempts the user has made in the `confirm` mode.
var numberOfConfirmAttempts = 0
/// The number of attempts the user has made in the `unlock` mode.
var numberOfUnlockAttempts = 0
/// The user failed to unlock the app (or forgot their PIN) and the log out is in progress.
var isLoggingOut = false
var title: String {
switch mode {
case .create: return L10n.screenAppLockSetupChoosePin
case .confirm: return L10n.screenAppLockSetupConfirmPin
case .unlock: return L10n.commonEnterYourPin
}
}
/// Whether the subtitle is in a warning state or not.
var isSubtitleWarning: Bool { mode == .unlock && numberOfUnlockAttempts > 0 }
var subtitle: String {
guard mode == .unlock else { return L10n.screenAppLockSetupPinContext(InfoPlistReader.main.bundleDisplayName) }
if !isSubtitleWarning {
return L10n.screenAppLockSubtitle(maximumAttempts)
} else {
return L10n.screenAppLockSubtitleWrongPin(maximumAttempts - numberOfUnlockAttempts)
}
}
var bindings: AppLockSetupPINScreenViewStateBindings
}
struct AppLockSetupPINScreenViewStateBindings {
var pinCode: String
var alertInfo: AlertInfo<AppLockSetupPINScreenAlertType>?
}
enum AppLockSetupPINScreenAlertType {
/// The user entered a weak PIN and it has been rejected.
case weakPIN
/// The user entered the wrong PIN when confirming the creation.
case pinMismatch
/// An error occurred setting the PIN code in the App Lock service.
case failedToSetPIN
/// The user has forgotten their PIN, confirm they're happy to sign out.
case confirmResetPIN
/// The user failed to unlock the app (or forgot their PIN).
case forceLogout
}
enum AppLockSetupPINScreenViewAction {
/// Stop entering a PIN.
case cancel
/// The user didn't heed the warnings and can't remember their PIN.
case forgotPIN
}