PinPolicy

public protocol PinPolicy

The object defining the minimum and maximum length of the PIN.

  • The minimum length of the PIN.

    Declaration

    Swift

    var minLength: Int { get }
  • The maximum length of the PIN.

    Declaration

    Swift

    var maxLength: Int { get }
  • Performs validation other than the minimum and maximum PIN length during PIN enrollment.

    This must be implemented in the case you require additional criteria for a PIN to be valid: the PIN must contain a minimum number of distinct digits, sequences of consecutive digits are disallowed, etc.

    If this method is not implemented, only the PIN minimum and maximum length will be validated during PIN enrollment.

    If validation fails, the implementation must invoke the provided onError with the error. The error will be the one returned by the lastRecoverableError property.

    The implementation must guarantee that, one (and only one) of onSuccess and onError is invoked, and that the one invoked is invoked only once.

    This method will be invoked in the main/UI thread.

    Synchronous implementation example that requires PIN to have at least 4 different digits:

    func validatePinForEnrollment(_ pin: String, onSuccess: @escaping () -> (), onError: @escaping (PinEnrollmentValidationError) -> ()) {
        if (hasLessThan4DifferentDigits(pin)) {
            return onError(.InvalidPin(message: "The PIN has less than 4 consecutive digits."))
        }
    
        onSuccess()
    }
    

    Declaration

    Swift

    func validatePinForEnrollment(_ pin: String, onSuccess: @escaping () -> (), onError: @escaping (PinEnrollmentValidationError) -> ())

    Parameters

    pin

    the PIN to be validated.

    onSuccess

    the block to execute if the validation is successful.

    onError

    the block to execute with the error if the validation fails.

  • Performs validation other than the minimum and maximum PIN length during PIN change.

    This must be implemented in the case you require additional criteria for a PIN to be valid: the PIN must contain a minimum number of distinct digits, sequences of consecutive digits are disallowed, etc.

    If this method is not implemented, only the PIN minimum and maximum length will be validated during PIN change.

    If validation fails, the implementation must invoke the provided onError with the error. The error will be the one returned by the lastRecoverableError property.

    The implementation must guarantee that, one (and only one) of onSuccess and onError is invoked, and that the one invoked is invoked only once.

    This method will be invoked in the main/UI thread.

    Synchronous implementation example that requires the PIN to be the same as a confirmation PIN provided in another field:

    func validatePinForPinChange(_ pin: String, onSuccess: @escaping () -> (), onError: @escaping (PinChangeValidationError) -> ()) {
        if (isDifferentThanConfirmationPIN(pin)) {
            return onError(.InvalidPin(message: "The provided PINs do not match."))
        }
    
        onSuccess()
    }
    

    Declaration

    Swift

    func validatePinForPinChange(_ pin: String, onSuccess: @escaping () -> (), onError: @escaping (PinChangeValidationError) -> ())

    Parameters

    pin

    the PIN to be validated.

    onSuccess

    the block to execute if the validation is successful.

    onError

    the block to execute with the error if the validation fails.