Enumerations

The following enumerations are available globally.

  • Declares client error types and codes

    • noBody: service response does not have body
    See more

    Declaration

    Swift

    @objc(VSSBaseClientError)
public enum BaseClientError : Int, LocalizedError

  • Declares error types and codes

    • noUrlInRequest: Provided URLRequest doesn’t have url
    • wrongResponseType: Response is not of HTTPURLResponse type
    See more

    Declaration

    Swift

    @objc(VSSServiceConnectionError)
public enum ServiceConnectionError : Int, LocalizedError

  • NetworkRetryOperation errors

    • timeout: timeout
    • reachabilityError: SCNetworkReachability returned error
    See more

    Declaration

    Swift

    public enum NetworkRetryOperationError : LocalizedError

  • Declares error types and codes

    • urlRequestIsIncompleteOrInvalid: Provided URLRequest is incomplete or invalid
    See more

    Declaration

    Swift

    @objc(VSSRequestError)
public enum RequestError : Int, LocalizedError

  • Declares error types and codes

    • invalidGetRequestParameters: GET request parameters are not [String: String] and cannot be encoded
    • urlComponentsConvertingFailed: Error building url from components during GET request
    • getQueryWithDecodableIsNotSupported: GET query with Encodable body is not supported
    • duplicateHeadersKey: Passed headers dictionary contains forbidden http header keys
    See more

    Declaration

    Swift

    @objc(VSSServiceRequestError)
public enum ServiceRequestError : Int, LocalizedError

  • Retry choice

    • noRetry: should not retry
    • retryService: retry due to service error
    • retryAuth: retry due to auth error (should try with new Access Token)
    • retryConnection: retry due connection error
    See more

    Declaration

    Swift

    public enum RetryChoice

  • Declares error types and codes for CardManager

    • cardIsNotVerified: Virgil Card was not verified by cardVerifier
    • gotWrongCard: Response Card doesn’t match to what was queried
    • chainWasRevoked: Virgil Card was revoked
    See more

    Declaration

    Swift

    @objc(VSSCardManagerError)
public enum CardManagerError : Int, LocalizedError

  • Declares client error types and codes

    • constructingUrl: constructing url of endpoint failed
    See more

    Declaration

    Swift

    @objc(VSSCardClientError)
public enum CardClientError : Int, LocalizedError

  • Declares error types and codes

    • invalidBase64String: Passed string is not correct base64 encoded string
    • duplicateSignature: Signature with same signer already exists
    See more

    Declaration

    Swift

    @objc(VSSRawSignedModelError)
public enum RawSignedModelError : Int, LocalizedError

  • Declares error types and codes

    • duplicateSigner: tried to add verifier credentials from same signer
    See more

    Declaration

    Swift

    @objc(VSSWhitelistError)
public enum WhitelistError : Int, LocalizedError

  • Declares error types and codes

    • incorrectNumberOfJwtComponents: Number of JWT components doesn’t equal 3
    • utf8StrIsInvalid: Invalid UTF8 string to sign
    See more

    Declaration

    Swift

    @objc(VSSJwtError)
public enum JwtError : Int, LocalizedError

  • Declares error types and codes

    • base64UrlStrIsInvalid: Given base64 string is invalid
    See more

    Declaration

    Swift

    @objc(VSSJwtBodyContentError)
public enum JwtBodyContentError : Int, LocalizedError

  • Declares error types and codes

    • base64UrlStrIsInvalid: given base64 string is invalid
    See more

    Declaration

    Swift

    @objc(VSSJwtHeaderContentError)
public enum JwtHeaderContentError : Int, LocalizedError

  • Declares error types and codes

    • base64UrlStrIsInvalid: Given base64 string is invalid
    See more

    Declaration

    Swift

    @objc(VSSJwtSignatureContentError)
public enum JwtSignatureContentError : Int, LocalizedError

  • Declares error codes for KeychainStorage. See KeychainStorageError

    • utf8ConvertingError: Error while converting string to utf8 binary
    • emptyKeychainResponse: Keychain response is nil
    • wrongResponseType: Unexpected keychain response type
    • errorParsingKeychainResponse: Error while deserializing keychain response
    • invalidAppBundle: Bundle.main.bundleIdentifier is empty
    • keychainError: Keychain returned error
    • creatingAccessControlFailed: SecAccessControlCreateWithFlags returned error
    See more

    Declaration

    Swift

    @objc(VSSKeychainStorageErrorCodes)
public enum KeychainStorageErrorCodes : Int

  • Declares error types and codes for KeychainStorageWrapper

    • errorConvertingKeychainEntry: Invalid Keychain entry
    See more

    Declaration

    Swift

    @objc(VSSSandboxedKeychainStorageError)
public enum SandboxedKeychainStorageError : Int, LocalizedError

  • Declares client error types and codes

    • constructingUrl: constructing url of endpoint failed
    • invalidPreviousHashHeader: error whilte extracting previousHash from response header
    • emptyIdentities: identities array is empty
    • invalidOptions: internal invalid options error
    See more

    Declaration

    Swift

    @objc(VSSKeyknoxClientError)
public enum KeyknoxClientError : Int, LocalizedError

  • Declares error types and codes for KeyknoxManager

    • entryNotFound: Entry was not found
    • entrySavingError: Error while saving entry
    • entryAlreadyExists: Entry already exists
    • cloudStorageOutOfSync: Sync this storage before any other operations
    See more

    Declaration

    Swift

    @objc(VSSCloudKeyStorageError)
public enum CloudKeyStorageError : Int, LocalizedError

  • Declares error types and codes for KeyknoxCrypto

    • decryptionFailed: Decryption failed
    • emptyPublicKeysList: Public keys list is empty
    • emptyData: Trying to encrypt empty data
    See more

    Declaration

    Swift

    @objc(VSSKeyknoxCryptoError)
public enum KeyknoxCryptoError : Int, LocalizedError

  • Declares error types and codes for KeyknoxManager

    • noPublicKeys: Public keys array is empty
    • serverRespondedWithTamperedValue: Value pushed to Keyknox and returned from Keyknox doesn’t match
    • dataIsEmpty: Data is empty
    See more

    Declaration

    Swift

    @objc(VSSKeyknoxManagerError)
public enum KeyknoxManagerError : Int, LocalizedError

  • Declares error types and codes for SyncKeyStorage

    • keychainEntryNotFoundWhileUpdating: KeychainEntry not found while updating
    • cloudEntryNotFoundWhileUpdating: CloudEntry not found while updating
    • cloudEntryNotFoundWhileDeleting: CloudEntry not found while deleting
    • keychainEntryNotFoundWhileComparing: KeychainEntry not found while comparing
    • keychainEntryAlreadyExistsWhileStoring: KeychainEntry already exists while storing
    • cloudEntryAlreadyExistsWhileStoring: CloudEntry already exists while storing
    • invalidModificationDateInKeychainEntry: Invalid modificationDate in KeychainEntry
    • invalidCreationDateInKeychainEntry: Invalid creationDate in KeychainEntry
    • noMetaInKeychainEntry: No meta in keychainEntry
    • invalidKeysInEntryMeta: Invalid keys in entry meta
    • inconsistentStateError: Inconsistent state error
    • entrySavingError: Error while saving entry
    See more

    Declaration

    Swift

    @objc(VSSSyncKeyStorageError)
public enum SyncKeyStorageError : Int, LocalizedError

  • Represents error of SQLite Binding

    • invalidString: Invalid String
    See more

    Declaration

    Swift

    @objc(VSSSQLiteBindingError)
public enum SQLiteBindingError : Int, LocalizedError

  • Aggregates common functions to use with JSONEncoder

    See more

    Declaration

    Swift

    public enum DateUtils
  • Log

    Class used for logging

    See more

    Declaration

    Swift

    public enum Log

  • Mutex error

    • unknownError: unknown error
    See more

    Declaration

    Swift

    public enum MutexError : Error

  • Declares error types and codes

    • errorAndResultMissing: Both Result and Error are missing in callback
    See more

    Declaration

    Swift

    @objc(VSSCallbackOperationError)
public enum CallbackOperationError : Int, LocalizedError

  • Declares error types and codes

    • timeout: Timeout has fired
    • resultIsMissing: Result variable is empty after execution
    • missingDependencies: Dependend operation result not found
    • dependencyFailed: Dependend operation has failed
    • operationCancelled: Operation was cancelled
    See more

    Declaration

    Swift

    @objc(VSSGenericOperationError)
public enum GenericOperationError : Int, LocalizedError

  • Class that helps to create Operation instances for common cases

    See more

    Declaration

    Swift

    public enum OperationUtils

  • Helper class to work with version

    See more

    Declaration

    Swift

    public enum VersionUtils