Errors

The biidCoreSDK defines the following error models objects, each returned for it’s respective completion handler

e.g. an InvalidTokenError is returned with the onInvalidToken completion handler

onInvalidToken: @escaping (_ error : InvalidTokenError) -> Void

See Error Handling for further information.

  • biidCoreSDK Error baseclass

    See more

    Declaration

    Swift

    protocol BiidError : CustomStringConvertible, Error
  • Error object returned with an onClientError completion handler. Returned when a biid Client method has failed

    See more

    Declaration

    Swift

    public struct ClientError : BiidError, LocalizedError
  • Error object returned with an onDIACLimitError completion handler. Returned when the user has entered an incorrect DIAC too many times.

    See more

    Declaration

    Swift

    public struct DIACLimitError : BiidError
  • Error object returned with an onInvalidTokenError completion handler. Returned when the user’s authentication has expired or is nolonger valid. A new token may be needed. The resolution specifies how this can be resolved.

    See more

    Declaration

    Swift

    public struct InvalidTokenError : BiidError
  • Error object returned with an onTransactionNotPendingError completion handler. Returned when a transaction is not pending i.e. cannot be signed or rejected

    See more

    Declaration

    Swift

    public struct TransactionNotPendingError : BiidError
  • Error object returned with an onUserLockedError completion handler. Returned when the user has been locked because an invalid verification code has been entered too many times.

    See more

    Declaration

    Swift

    public struct UserLockedError : BiidError
  • Error object returned with an onValidationError completion handler. Returned when one or more parameters are not valid. The error contains a mapping between field names and error messages. A field name is either a user field name as defined in the backoffice or a parameter name of the biid Client method.

    See more

    Declaration

    Swift

    public struct ValidationError : BiidError
  • Base Error object returned with completion handlers that return errors when the user is in an invalid state for calling the API.

    See more

    Declaration

    Swift

    public class InvalidUserStateError : InvalidUserState
  • Error object returned with an onUserAlreadyRegisteredError completion handler. Returned when user registration has failed because the user is already registered.

    Declaration

    Swift

    final public class UserAlreadyRegisteredError : InvalidUserStateError
  • Error object returned with an onDeviceNotVerifiedError completion handler. Returned when the user’s device must be verified in order to call the API.

    Declaration

    Swift

    final public class UserDeviceNotVerifiedError : InvalidUserStateError
  • Error object returned with an onUserNotAccreditedError completion handler. Returned when the user has not been accredited and no DIAC has yet been generated.

    Declaration

    Swift

    final public class UserNotAccreditedError : InvalidUserStateError
  • Error object returned with an onUserNotCertifiedError completion handler. Returned when the user must be certified in order to call the API.

    Declaration

    Swift

    final public class UserNotCertifiedError : InvalidUserStateError
  • Error object returned with an onUserNotAccreditedError completion handler. Returned when the user must be registered in order to call the API.

    Declaration

    Swift

    final public class UserNotRegisteredError : InvalidUserStateError
  • Error object returned with an onVerificationCodeAttemptsError completion handler. Returned when the user has been locked after entering a verfication code too many times.

    See more

    Declaration

    Swift

    public struct VerificationCodeAttemptsError : BiidError
  • Error object returned with an onVerificationCodeExpiredError completion handler. Returned when the verification code has expired and the user has to request a verification code again.

    See more

    Declaration

    Swift

    public struct VerificationCodeExpiredError : BiidError
  • Error object returned with an onVerificationRequestLimitError completion handler. Returned when the user has reached the limit for requesting a verification code for the device.

    See more

    Declaration

    Swift

    public struct VerificationRequestLimitError : BiidError