D1Error

public struct D1Error : Error
extension D1Error: LocalizedError

Contains the D1 errors.

Note

When an error occurs and support is required, it is recommended to include the full error details including the underlying errors in the report.

Since

1.0.0

  • Contains the D1 error codes.

    Note

    D1 SDK returns one of these error codes for each D1Error.

    Since

    1.0.0

    See more

    Declaration

    Swift

    public enum Code : Int, CaseIterable

  • Returns the error code D1Error.Code.

    Declaration

    Swift

    public let code: Code

  • Warning

    D1Error.underlyingError is deprecated since the value will be included in the errorDescription API.

    Returns the error that was encountered in an underlying implementation.

    Declaration

    Swift

    @available(*, deprecated, message: "D1Error.underlyingError is deprecated since the value will be included in the errorDescription API.")
public var underlyingError: NSError?

  • Warning

    D1Error.failureReason is deprecated since the value will be included in the errorDescription API.

    The reason for the error encountered. This contains information pertaining to the underlying cause of the error.

    Declaration

    Swift

    @available(*, deprecated, message: "    D1Error.failureReason is deprecated since the value will be included in the errorDescription API.")
public var failureReason: String? { get }

  • Retrieves the underlying error name, error code, cause error code and cause error message.

    The error message is in <D1ErrorName> [<D1-ErrorCode>] (<CauseErrorCode>) <CauseErrorMessage> format where (CauseErrorCode) and <CauseErrorMessage> are optional.

    Since

    3.4.0

    Declaration

    Swift

    public var errorDescription: String? { get }

    Return Value

    formatted error message.

  • Warning

    D1Error.recoverySuggestion is deprecated since D1Error.Code.description will be removed.

    Recovery suggestion information.

    Declaration

    Swift

    @available(*, deprecated, message: "    D1Error.recoverySuggestion is deprecated since D1Error.Code.description will be removed.")
public var recoverySuggestion: String? { get }