Class ZipApiException

An exception thrown by ZipClient when an error response is received from the Zip API.

Inheritance

Object

Exception

ZipApiException

Implements

ISerializable

Inherited Members

Exception.GetBaseException()

Exception.GetObjectData(SerializationInfo, StreamingContext)

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Yort.Zip.InStore

Assembly: Yort.Zip.InStore.dll

Syntax

[Serializable]
public class ZipApiException : Exception, ISerializable

Constructors

ZipApiException()

Default constructor. Not recommended for use.

Declaration

public ZipApiException()

ZipApiException(SerializationInfo, StreamingContext)

Deserialisation constructor.

Declaration

protected ZipApiException(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info	The serialisation information to deserialise from.
StreamingContext	context	The streaming context to deserialise from.

ZipApiException(String)

Partial constructor. Not recommended for use.

Declaration

public ZipApiException(string message)

Parameters

Type	Name	Description
String	message	The error message of the exception.

ZipApiException(String, Exception)

Partial constructor. Not recommended for use.

Declaration

public ZipApiException(string message, Exception inner)

Parameters

Type	Name	Description
String	message	The error message for this exception.
Exception	inner	Another exception being wrapped by this one.

ZipApiException(ZipErrorResponse)

Partial constructor, recommended.

Declaration

public ZipApiException(ZipErrorResponse error)

Parameters

Type	Name	Description
ZipErrorResponse	error	A ZipErrorResponse containing full errors received from the Zip API.

ZipApiException(ZipErrorResponse, Exception)

Full constructor, recommended.

Declaration

public ZipApiException(ZipErrorResponse error, Exception inner)

Parameters

Type	Name	Description
ZipErrorResponse	error	A ZipErrorResponse containing full errors received from the Zip API.
Exception	inner	Another exception being wrapped by this one.

Properties

Errors

Returns a ZipErrorResponse instance containing details of the full set of errors, or null if no response content was provided by the Zip API.

Declaration

public ZipErrorResponse Errors { get; }

Property Value

Type	Description
ZipErrorResponse

Implements

System.Runtime.Serialization.ISerializable