WebcomError - Webcom iOS SDK

Types

SDKCode
A value representing an error code specific to this iOS SDK.
See more
Declaration
Swift

public enum SDKCode : Hashable, SelfIdentifiable
BackEndCode
A value representing an error code from the back-end.
See more
Declaration
Swift

public enum BackEndCode : String, Hashable, SelfIdentifiable


                    
                    
                    Code

A value representing an error code.

Declaration

Swift

@frozen
public enum Code : Hashable, SelfIdentifiable, CustomStringConvertible

Stored Properties

code
The code of the error.
Declaration
Swift

public let code: Code
message
A message explaining the error.
Declaration
Swift

public let message: String?
cause
An underlying error that causes this one.
Declaration
Swift

public let cause: Error?

API


                    
                    
                    from(_:)

Creates a WebcomError corresponding to the given Error.

When error is already a WebcomError, it is returned unchanged. Otherwise error is wrapped as the cause of a new WebcomError instance.

Declaration

Swift

public static func from(_ error: Error) -> WebcomError

Parameters


                                error

The error to process.

Return Value

A WebcomError equal to or wrapping error.

Equatable Protocol


                    
                    
                    ==(_:_:)

Indicates whether two instances are equal.

This comparison uses the String(describing:) initializer to compare the cause values of the two instances. Also, two instances with equal code values, equal messagevalues but unequal cause values having the same representation according to String(describing:) are considered equal by this method. This is an acceptable approximation as this situation is unlikely to occur.

Declaration

Swift

public static func == (left: `Self`, right: `Self`) -> Bool

Parameters

`left`	The first instance to compare.
`right`	The second instance to compare.

Return Value

true when the two instances are equal, false otherwise.

CustomStringConvertible Protocol

description
Declaration
Swift

public var description: String { get }

LocalizedError Protocol


                    
                    
                    errorDescription

Declaration

Swift

public var errorDescription: String? { get }