UsherError

public struct UsherError : UsherErrorProtocol, Equatable

Usher Error.

  • code

    The error code.

    Declaration

    Swift

    public var code: Int
  • title

    The title of the error.

    Declaration

    Swift

    public var title: String
  • message

    The message for the error.

    Declaration

    Swift

    public var message: String
  • info

    Detailed information for the error.

    Declaration

    Swift

    public var info: String
  • status

    Server response error status.

    Declaration

    Swift

    public var status: String?
  • reason

    Server response error reason.

    Declaration

    Swift

    public var reason: String?
  • localizedMessage

    Server response error localized message.

    Declaration

    Swift

    public var localizedMessage: String?
  • httpResponseStatusCode

    HTTP Response Status Code

    Declaration

    Swift

    public var httpResponseStatusCode: Int
  • init(code:title:message:info:)

    Initializer.

    Declaration

    Swift

    public init(code: Int = 100,
            title: String = "Error",
            message: String = "mstr-ios-100",
            info: String? = "")
    Parameters
    code

    The error code. NOTE: code numbers from Int.min -> 600 are reserved for errors created in the SDK. Avoid using them.
    title

    Title of the error
    message

    Message
    info

    Information
  • init(error:)

    Construct an error from NSError.

    Declaration

    Swift

    public init(error: NSError)
    Parameters
    error

    NSError object.
  • description

    Verbose description. Should only be used for debugging only.

    Declaration

    Swift

    public var description: String { get }
  • kind

    The error’s kind.

    Declaration

    Swift

    public var kind: ErrorKind { get }
  • notPermitted

    This application has no permission to perform this operation. Error Code 600.

    Declaration

    Swift

    @available(*, deprecated, message: "This error will never happen and will be removed in future release")
public static let notPermitted: UsherError
  • accessTokenExpired

    Invalid or expired access token. Error Code 601.

    Declaration

    Swift

    public static let accessTokenExpired: UsherError
  • refreshTokenExpired

    The refresh token has expired. Error Code 832.

    Declaration

    Swift

    public static let refreshTokenExpired: UsherError
  • userAlreadyExists

    The user already exists. Error Code 900.

    Declaration

    Swift

    public static let userAlreadyExists: UsherError
  • userNotFound

    User not found. Error Code 901.

    Declaration

    Swift

    public static let userNotFound: UsherError
  • invalidUserId

    Invalid user ID. Error Code 902.

    Declaration

    Swift

    public static let invalidUserId: UsherError
  • invalidCredential

    Invalid credential. Error Code 903.

    Declaration

    Swift

    public static let invalidCredential: UsherError
  • userLocked

    User Locked. Error Code 904.

    Declaration

    Swift

    public static let userLocked: UsherError
  • invalidKeyVersion

    Invalid key version. Error Code 905.

    Declaration

    Swift

    public static let invalidKeyVersion: UsherError
  • invalidInput

    Invalid input. Error Code 906.

    Declaration

    Swift

    public static let invalidInput: UsherError
  • passwordEncryptionFailed

    Password encryption failed. Error Code 10004.

    Declaration

    Swift

    public static let passwordEncryptionFailed: UsherError
  • invalidImage

    Invalid image. Error Code 10005.

    Declaration

    Swift

    @available(*, deprecated, message: "This error will never happen and will be removed in future release")
public static let invalidImage: UsherError
  • invalidServerUrl

    Invalid server URL. Error Code 10006.

    Declaration

    Swift

    public static let invalidServerUrl: UsherError
  • userNotLoggedIn

    User is not logged in. Error Code 10007.

    Declaration

    Swift

    public static let userNotLoggedIn: UsherError
  • passwordPolicyError

    Password policy cannot be retrieved. Error Code 11000.

    Declaration

    Swift

    @available(*, deprecated, message: "This error will never happen and will be removed in future release")
public static let passwordPolicyError: UsherError
  • passwordValidationGenericError

    Generic password policy validation error. Error Code 11001.

    Declaration

    Swift

    public static let passwordValidationGenericError: UsherError
  • passwordTooShort

    Password is less than the allowed minimum length. Error Code 11002.

    Declaration

    Swift

    public static let passwordTooShort: UsherError
  • passwordTooLong

    Password is longer than the allowed maximum length. Error Code 11003.

    Declaration

    Swift

    public static let passwordTooLong: UsherError
  • noLowerCaseInPassword

    Password doesn’t contain any lower case character. Error Code 11004.

    Declaration

    Swift

    public static let noLowerCaseInPassword: UsherError
  • noUpperCaseInPassword

    Password doesn’t contain any upper case character. Error Code 11005.

    Declaration

    Swift

    public static let noUpperCaseInPassword: UsherError
  • noNumberInPassword

    Password doesn’t contain any numeric character. Error Code 11006.

    Declaration

    Swift

    public static let noNumberInPassword: UsherError
  • noSymbolsInPassword

    Password doesn’t contain at least one allowed special character. Error Code 11007.

    Declaration

    Swift

    public static let noSymbolsInPassword: UsherError
  • notAllowedSymbolsInPassword

    Password contains one or more not allowed special symbols. Error Code 11008.

    Declaration

    Swift

    public static let notAllowedSymbolsInPassword: UsherError
  • invalidEmailAddress

    Invalid email address. Error Code 11009.

    Declaration

    Swift

    public static let invalidEmailAddress: UsherError
  • noAlphabeticCharInPassword

    Password doesn’t contain at least one alphabetic character. Error code 11010.

    Declaration

    Swift

    public static let noAlphabeticCharInPassword: UsherError
  • oldPasswordInvalid

    Old password is invalid while trying to change the password. Error code 11011.

    Declaration

    Swift

    public static let oldPasswordInvalid: UsherError
  • passwordHistroyPolicyNotMet

    Password history policy not met. Error code 11012.

    Declaration

    Swift

    public static let passwordHistroyPolicyNotMet: UsherError
  • bioAuthenticationFailed

    Authentication was not successful because the user failed to provide valid credentials. Error Code 12000.

    Declaration

    Swift

    public static let bioAuthenticationFailed: UsherError
  • passcodeNotSet

    Authentication could not start because the passcode is not set on the device. Error Code 12001.

    Declaration

    Swift

    public static let passcodeNotSet: UsherError
  • systemCanceledBioAuthentication

    Biometric authentication canceled by system. Error Code 12002.

    Declaration

    Swift

    public static let systemCanceledBioAuthentication: UsherError
  • userCanceledBioAuthentication

    Biometric authentication canceled by user. Error Code 12003.

    Declaration

    Swift

    public static let userCanceledBioAuthentication: UsherError
  • biometryLockout

    Biometric authentication user locked out. Error Code 12004.

    Declaration

    Swift

    public static let biometryLockout: UsherError
  • biometryNotAvailable

    Biometric authentication not available. Error Code 12005.

    Declaration

    Swift

    public static let biometryNotAvailable: UsherError
  • biometryNotEnrolled

    Biometrc authentication not enrolled. Error Code 12006.

    Declaration

    Swift

    public static let biometryNotEnrolled: UsherError
  • genericBioAuthenticationError

    Generic biometric authentication error. Error Code 12007.

    Declaration

    Swift

    public static let genericBioAuthenticationError: UsherError
  • genericDataError

    Generic error occured when reading data. Error Code 30000.

    Declaration

    Swift

    public static let genericDataError: UsherError
  • genericKeychainError

    Generic keychain error. Error Code 31000.

    Declaration

    Swift

    public static let genericKeychainError: UsherError
  • keychainDataLoadError

    Generic error occured when reading keychain. Error Code 31001.

    Declaration

    Swift

    public static let keychainDataLoadError: UsherError
  • keychainDataUserCancelledBiometricAuthorization

    User canceled biometric authorization for reading keychain. Error Code 31002.

    Declaration

    Swift

    public static let keychainDataUserCancelledBiometricAuthorization: UsherError
  • keychainDataCannotBeUnlocked

    Keychain data cannot be unlocked. This could happen if keychain was encrypted with biometry and biometry authentication is disabled afterwards. Error Code 31003.

    Declaration

    Swift

    public static let keychainDataCannotBeUnlocked: UsherError
  • sdkNotInitialized

    SDK is not initialized yet. Error Code 32001.

    Declaration

    Swift

    @available(*, deprecated, message: "This error will never happen and will be removed in future release")
public static let sdkNotInitialized: UsherError
  • sdkInitializedWithUserDataReset

    SDK is initialized with user data reset. Error Code 32002.

    Declaration

    Swift

    public static let sdkInitializedWithUserDataReset: UsherError
  • unknown

    Other unknown error. Error Code 0.

    Declaration

    Swift

    static let unknown: UsherError

NSURLSessionErrors ( < 0 )
  • cancelled

    An asynchronous load has been canceled. Error Code -999.

    Declaration

    Swift

    static let cancelled: UsherError
  • timedOut

    Request timed out. Error Code -1001.

    Declaration

    Swift

    static let timedOut: UsherError
  • cannotFindHost

    The host name for a URL could not be resolved. Error Code -1003.

    Declaration

    Swift

    static let cannotFindHost: UsherError
  • cannotConnectToHost

    An attempt to connect to a host failed. Error Code -1004.

    Declaration

    Swift

    static let cannotConnectToHost: UsherError
  • resourceUnavailable

    Resource unavailable. Error Code -1008.

    Declaration

    Swift

    static let resourceUnavailable: UsherError
  • offline

    A network resource was requested, but an internet connection has not been established and cannot be established automatically. Error Code -1009.

    Declaration

    Swift

    static let offline: UsherError
  • internationalRoamingOff

    The attempted connection required activating a data context while roaming, but international roaming is disabled. Error Code -1018.

    Declaration

    Swift

    static let internationalRoamingOff: UsherError
  • dataNotAllowed

    The cellular network disallowed a connection. Error Code -1020.

    Declaration

    Swift

    static let dataNotAllowed: UsherError
  • clientCertificateInvalid

    An attempt to establish a secure connection failed for reasons that can’t be expressed more specifically. Error Code -1200.

    Declaration

    Swift

    static let clientCertificateInvalid: UsherError
  • clientCertificateRejected

    A server certificate was rejected. Error Code -1205.

    Declaration

    Swift

    static let clientCertificateRejected: UsherError

Generic errors ( 0...149 )
  • generic

    Generic SDK error. Error Code 100.

    Declaration

    Swift

    static let generic: UsherError
  • jsonParsingFailed

    JSON parsing failed. Error Code 101.

    Declaration

    Swift

    static let jsonParsingFailed: UsherError
  • deviceJailbroken

    Jailbroken device. Error Code 102.

    Declaration

    Swift

    static let deviceJailbroken: UsherError
  • deviceNotPasscodeProtected

    Device is not passcode protected. Error Code 103.

    Declaration

    Swift

    static let deviceNotPasscodeProtected: UsherError
  • invalidDeeplink

    Invalid deeplink. Error Code 104.

    Declaration

    Swift

    static let invalidDeeplink: UsherError
  • actionCannotBeDoneInTheBackground

    Action cannot be performed in the background. Error Code 105.

    Declaration

    Swift

    static let actionCannotBeDoneInTheBackground: UsherError

Usher API Executor errors ( 150...199 )
  • missingServer

    Server is missing. Error Code 150.

    Declaration

    Swift

    static let missingServer: UsherError
  • missingDevice

    Device is missing. Error Code 151.

    Declaration

    Swift

    static let missingDevice: UsherError
  • missingRequestConfiguration

    Request configuration is missing. Error Code 152.

    Declaration

    Swift

    static let missingRequestConfiguration: UsherError
  • missingAccessToken

    Access token is missing. Error Code 153.

    Declaration

    Swift

    static let missingAccessToken: UsherError
  • requestExecutorStopped

    Request executor stopped. Error Code 154.

    Declaration

    Swift

    static let requestExecutorStopped: UsherError
  • alamofireRequestCreationFailed

    Failed to create Alamofire request. Error Code 155.

    Declaration

    Swift

    static let alamofireRequestCreationFailed: UsherError
  • requestCancelled

    The request was cancelled. Error Code 156.

    Declaration

    Swift

    static let requestCancelled: UsherError
  • requestNotExecutable

    Request is not executable. Error Code 157.

    Declaration

    Swift

    static let requestNotExecutable: UsherError
  • invalidAccessToken

    Access token is invalid. Error Code 158.

    Declaration

    Swift

    static let invalidAccessToken: UsherError
  • invalidRefreshToken

    Refresh token is invalid. Error Code 159.

    Declaration

    Swift

    static let invalidRefreshToken: UsherError
  • genericAPIRequestError

    Generic API Request error. Error Code 199.

    Declaration

    Swift

    static let genericAPIRequestError: UsherError

HTTP Errors ( 400...599 )
  • badRequest

    The server cannot or will not process the request due to an apparent client error. Error Code 400.

    Declaration

    Swift

    static let badRequest: UsherError
  • unauthorized

    Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. Error Code 401.

    Declaration

    Swift

    static let unauthorized: UsherError
  • forbidden

    The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource. Error Code 403.

    Declaration

    Swift

    static let forbidden: UsherError
  • notFound

    The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. Error Code 404.

    Declaration

    Swift

    static let notFound: UsherError
  • methodNotAllowed

    A request method is not supported for the requested resource. For example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource. Error Code 405.

    Declaration

    Swift

    static let methodNotAllowed: UsherError
  • requestTimedOut

    The server timed out waiting for the request. Error Code 408.

    Declaration

    Swift

    static let requestTimedOut: UsherError
  • internalServerError

    A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. Error Code 500.

    Declaration

    Swift

    static let internalServerError: UsherError
  • notImplemented

    The server either does not recognize the request method or lacks the ability to fulfill the request. Usually this implies future availability. Error Code 501.

    Declaration

    Swift

    static let notImplemented: UsherError
  • badGateway

    Bad gateway error. Error Code 502.

    Declaration

    Swift

    static let badGateway: UsherError
  • serviceUnavailable

    The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state. Error Code 503.

    Declaration

    Swift

    static let serviceUnavailable: UsherError