PrivMX DOCS
API Reference/PrivMX Endpoint Swift/Errors

PrivMXEndpointError

Errors thrown by PrivMX Endpoint Swift. Cases correspond to methods in which the error happened. Each case has privmx.InternalError as associated value, which holds data about the error.

Fields

otherFailure(_:)

Enum Case Represents failure unrelated to methods in PrivmxEndpointSwift package

failedGettingConnectionId(_:)

Enum Case Failed to get Connection ID

failedGeneratingSymmetricKey(_:)

Enum Case Failed to generate Symmetric Key

failedEncrypting(_:)

Enum Case Failed to encrypt data.

failedDecrypting(_:)

Enum Case Failed to decrypt data.

failedSigning(_:)

Enum Case Failed to sign data.

failedVerifyingSignature(_:)

Enum Case Failed to verify Signature.

failedGeneratingPubKey(_:)

Enum Case Failed to create a Public Key.

failedGeneratingPrivKey(_:)

Enum Case Failed to create a Private Key.

failedConvertingKeyToWIF(_:)

Enum Case Failed to convert a Key to WIF.

failedConnecting(_:)

Enum Case Failed to connect.

failedDisconnecting(_:)

Enum Case Failed to disconnect.

failedListingContexts(_:)

Enum Case Failed to list Contexts.

failedGettingContextUsers(_:)

Enum Case Failed to get a list of Users from a Context.

failedInstantiatingThreadApi(_:)

Enum Case Failed to instantiate ThreadApi.

failedCreatingThread(_:)

Enum Case Failed to create a Thread.

failedGettingThread(_:)

Enum Case Failed to get a Thread.

failedListingThreads(_:)

Enum Case Failed to list Threads.

failedGettingMessage(_:)

Enum Case Failed to get a Message.

failedListingMessages(_:)

Enum Case Failed to list Messages.

failedCreatingMessage(_:)

Enum Case Failed to create a Message.

failedUpdatingThread(_:)

Enum Case Failed to update a Thread.

failedUpdatingMessage(_:)

Enum Case Failed to update a Message.

failedInstantiatingStoreApi(_:)

Enum Case Failed to instantiate StoreApi.

failedListingStores(_:)

Enum Case Failed to list Stores.

failedGettingStore(_:)

Enum Case Failed to get a Store.

failedCreatingStore(_:)

Enum Case Failed to create a Store.

failedUpdatingStore(_:)

Enum Case Failed to update a Store.

failedGettingFile(_:)

Enum Case Failed to get a File.

failedListingFiles(_:)

Enum Case Failed to list Files.

failedCreatingFile(_:)

Enum Case Failed to create a File.

failedUpdatingFile(_:)

Enum Case Failed to update a File.

failedOpeningFile(_:)

Enum Case Failed to open a File.

failedReadingFromFile(_:)

Enum Case Failed to read from a File.

failedSeekingInFile(_:)

Enum Case Failed to seek in a File.

failedWritingToFile(_:)

Enum Case Failed to write to a File.

failedClosingFile(_:)

Enum Case Failed to close a File.

failedDeletingFile(_:)

Enum Case Failed to delete a File.

failedInstantiatingInboxApi(_:)

Enum Case Failed to instantiate InboxApi.

failedCreatingInbox(_:)

Enum Case Failed to create an Inbox.

failedUpdatingInbox(_:)

Enum Case Failed to update an Inbox.

failedDeletingInbox(_:)

Enum Case Failed to delete an Inbox.

failedGettingInbox(_:)

Enum Case Failed to get an Inbox.

failedGettingInboxPublicView(_:)

Enum Case Failed to get a Public View of an Inbox.

failedListingInboxes(_:)

Enum Case Failed to list Inboxes.

failedPreparingEntry(_:)

Enum Case Failed to prepare an Entry.

failedSendingEntry(_:)

Enum Case Failed to send an Entry.

failedReadingEntry(_:)

Enum Case Failed to read an Entry.

failedDeletingEntry(_:)

Enum Case Failed to delete an Entry.

failedListingEntries(_:)

Enum Case Failed to list Entries.

failedCreatingFileHandle(_:)

Enum Case Failed to create a File Handle.

failedWaitingForEvent(_:)

Enum Case Failed to wait for an Event.

failedGettingEvent(_:)

Enum Case Failed to get an Event.

failedSubscribingForEvents(_:)

Enum Case Failed to subscribe for Events.

failedUnsubscribingFromEvents(_:)

Enum Case Failed to unsubscribe from Events.

failedDeletingThread(_:)

Enum Case Failed to delete a Thread.

failedDeletingMessage(_:)

Enum Case Failed to delete a Message.

failedDeletingStore(_:)

Enum Case Failed to delete a Store.

failedQueryingEventHolder(_:)

Enum Case Failed to query and EventHolder.

failedExtractingEventFromHolder(_:)

Enum Case Failed to extract an Event from an EventHolder.

failedSettingCerts(_:)

Enum Case Failed to set Certificates.

failedInstantiatingEventQueue(_:)

Enum Case Failed to instantiate EventQueue.

failedEmittingBreakEvent(_:)

Enum Case Failed to emit LibBreakEvent.

failedRequestingBackend(_:)

Enum Case Failed to send a request to the backend.

failedInstantiatingEventApi(_:)

Enum Case Failed to instantiate EventApi.

failedEmittingCustomEvent(_:)

Enum Case Failed to emit a CustomEvent.

failedSubscribingForCustomEvents(_:)

Enum Case Failed to subscribe for Custom Events.

failedUnsubscribingFromCustomEvents(_:)

Enum Case Failed to subscribe for Custom Events.

failedSettingUserVerifier(_:)

Enum Case Failed to set a User Verifier.

failedInstantiatingExtKey(_:)

Enum Case Failed to instantiate ExtKey.

failedDerivingExtKey(_:)

Enum Case Failed to derive ExtKey.

failedGettingPrivatePartAsBase58(_:)

Enum Case Failed to get private part as Base58.

failedGettingPublicPartAsBase58(_:)

Enum Case Failed to get public part as Base58.

failedGettingPrivateKey(_:)

Enum Case Failed to get private key.

failedGettingPublicKey(_:)

Enum Case Failed to get public key.

failedGettingPublicKeyAsBase58Address(_:)

Enum Case Failed to get public key as Base58 Address.

failedGettingPrivateEncKey(_:)

Enum Case Failed to get private Enc key.

failedGettingChainCode(_:)

Enum Case Failed to get chain code.

failedVerifyingCompactSignature(_:)

Enum Case Failed to verify compact signature.

failedCheckingIfExtKeyIsPrivate(_:)

Enum Case Failed to check if ExtKey is private.

failedConvertingKeyToBase58DER(_:)

Enum Case Failed to convert a PGP Asn1 key to Base58DER.

failedGeneratingBIP39(_:)

Enum Case Failed to generate a BIP39 instance.

failedConvertingEntropyToMnemonic(_:)

Enum Case Failed to convert Entropy to a Mnemonic.

failedConvertingMnemonicToEntropy(_:)

Enum Case Failed to convert a Mnemonic to Entropy.

failedGeneratingSeedFromMnemonic(_:)

Enum Case Failed to generate a Seed for BIP39 Key from a Mnemonic.

failedEncodingToHex(_:)

Enum Case Failed to encode data to Hex.

failedEncodingToBase64(_:)

Enum Case Failed to encode data to Base64.

failedEncodingToBase32(_:)

Enum Case Failed to encode data to Base32.

failedDecodingFromHex(_:)

Enum Case Failed to decode from Hex.

failedDecodingFromBase64(_:)

Enum Case Failed to decode from Base64.

failedDecodingFromBase32(_:)

Enum Case Failed to decode from Base32.

failedCheckingifStringIsHex(_:)

Enum Case Failed to check if the string is in Hex.

failedCheckingifStringIsBase64(_:)

Enum Case Failed to check if the string is in Base64.

failedCheckingifStringIsBase32(_:)

Enum Case Failed to check if the string is in Base32.

failedTrimmingString(_:)

Enum Case Failed to trim the string.

failedSplittingString(_:)

Enum Case Failed to split the string.

failedInstantiatingKvdbApi(_:)

Enum Case Failed to instantiate KvdbApi.

failedCreatingKvdb(_:)

Enum Case Failed to create a KVDB.

failedUpdatingKvdb(_:)

Enum Case Failed to update a KVDB.

failedDeletingKvdb(_:)

Enum Case Failed to delete a KVDB.

failedGettingKvdb(_:)

Enum Case Falied to get a KVDB.

failedListingKvdbs(_:)

Enum Case Falied to list KVDBs.

failedCheckingIfEntryExists(_:)

Enum Case Failed to check if a KVDB Entry exists.

failedGettingKvdbEntry(_:)

Enum Case Falied to get an KVDB Entry.

failedListingKvdbEntries(_:)

Enum Case Falied to list KVDB Entries.

failedListingKvdbEntriesKeys(_:)

Enum Case Falied to list KVDB Entries Keys.

failedSettingKvdbEntry(_:)

Enum Case Falied to set an KVDB Entry.

failedDeletingKvdbEntry(_:)

Enum Case Falied to delete an KVDB Entry.

failedDeletingKvdbEntries(_:)

Enum Case Falied to delete KVDB Entries.

Methods

getMessage()

Gets the Message of the error.

public func getMessage(
) -> String

Returns

String · Message of the error

getCode()

Gets the Code of the error, if it exists.

public func getCode(

) -> CUnsignedInt?

Returns

CUnsignedInt? · Code of the internal error, or nil

getName()

Gets the Name of the error.

public func getName(
) -> String

Returns

String · Name of the error

getDescription()

Gets the Description of the error.

public func getDescription(
) -> String

Returns

String · Description of the error

getScope()

Gets the Scope of the error as a String.

public func getScope(
) -> String?

Returns

String? · Scope of the error

We use cookies on our website. We use them to ensure the proper functioning of the site and, if you agree, for purposes we set, such as analytics or marketing.