Enumerations

The following enumerations are available globally.

  • Declares error types and codes for EThree

    • verifierInitFailed: Initialization of VirgilCardVerifier failed
    • strToDataFailed: String to Data failed
    • strFromDataFailed: Data to String failed
    • missingPrivateKey: No private key on device. You should call register() of retrievePrivateKey()
    • missingPublicKey: Passed empty FindUsersResult
    • missingIdentities: Passed empty array of identities to findUsers
    • userIsAlreadyRegistered: User is already registered
    • userIsNotRegistered: User is not registered
    • privateKeyExists: Private key already exists in local key storage
    • verificationFailed: Verification of message failed. This may be caused by rotating sender key. Try finding new one
    See more

    Declaration

    Swift

    @objc(VTEEThreeError)
public enum EThreeError : Int, LocalizedError

  • Declares error types and codes for EThreeRarams

    • invalidPlistFile: Invalid config file structure
    • unknownKeyInConfig: Config file contains unknown key
    See more

    Declaration

    Swift

    @objc(VTEEThreeParamsError)
public enum EThreeParamsError : Int, LocalizedError

  • Declares error types and codes for EThree Ratchet capabilities

    • encryptEmptyArray: Trying to encrypt empty array
    • decryptEmptyArray: Trying to decrypt empty array
    • channelAlreadyExists: Channel with provided user and name already exists
    • selfChannelIsForbidden: Channel with self is forbidden. Use regular encryption for this purpose.
    • ratchetIsDisabled: enableRatchet parameter is set to false
    • userIsNotUsingRatchet: Provided user has been never initialized with ratchet enabled
    • noInvite: There is no invitation from provided user
    • noSelfCardLocally: There is no self card in local storage
    See more

    Declaration

    Swift

    @objc(VTEEThreeRatchetError)
public enum EThreeRatchetError : Int, LocalizedError

  • Declares error types and codes for finding users

    • duplicateCards: Found duplicated Cards
    • missingCachedCard: Card with provided identity was not found locally. Try to call findUsers first
    • cardWasNotFound: Card for one or more of provided identities was not found
    See more

    Declaration

    Swift

    @objc(VTEFindUsersError)
public enum FindUsersError : Int, LocalizedError

  • Declares error types and codes for Group

    • missingCachedGroup: Group with provided id not found locally. Try to call loadGroup first
    • groupPermissionDenied: Only group initiator can do changed on group
    • groupWasNotFound: Group with provided id was not found
    • invalidGroup: Group is invalid
    • invalidChangeParticipants: Invalid change of group participants. e.g. Add smb who is already in group or remove smb who is not
    • invalidParticipantsCount: Please check valid participants count range in Group.ValidParticipantsCountRange
    • verificationFailed: Verification of message failed. This may be caused by rotating sender key. Try finding new one
    • shortGroupId: Group Id length should be > 10
    • messageNotFromThisGroup: Message was encrypted in group with different identifier
    • groupIsOutdated: Group is not up to date. Call update or loadGroup
    • inconsistentState: Inconsistent state
    See more

    Declaration

    Swift

    @objc(VTEEGroupError)
public enum GroupError : Int, LocalizedError

  • Declares error types and codes for EThree Temporary Channel capabilities

    • channelAlreadyExists: Temporary channel with provided identity already exists.
    • selfChannelIsForbidden: Temporary channel with self is forbidden. Use regular encryption for this purpose.
    • userIsRegistered: User with provided identity is registered. Creation of temporary channels with registered users is forbidden.
    • channelNotFound: Channel was not found
    See more

    Declaration

    Swift

    @objc(VTETemporaryChannelError)
public enum TemporaryChannelError : Int, LocalizedError

  • Declares error types and codes for RawGroup

    • emptyTickets: Tickets are empty
    See more

    Declaration

    Swift

    @objc(VTERawGroupError)
public enum RawGroupError : Int, LocalizedError

  • Declares error types and codes for FileGroupStorage

    • invalidFileName:
    • emptyFile:
    See more

    Declaration

    Swift

    @objc(VTEFileGroupStorageError)
public enum FileGroupStorageError : Int, LocalizedError

  • Represents error of SQLiteCardStorage

    • inconsistentDb: Storage turned into inconsistency state
    • emptyIdentities: Empty identities
    See more

    Declaration

    Swift

    @objc(VTESQLiteCardStorageError)
public enum SQLiteCardStorageError : Int, LocalizedError