Show / Hide Table of Contents

Class ApiException

Exception thrown when an API error occurs

Inheritance
Object
Exception
ApiException
AuthFailedException
ConditionFailedException
OperationFailedException
ParsingFailedException
WritingFailedException
Implements
ISerializable
Namespace: Seltzr.Exceptions
Assembly: Seltzr.dll
Syntax
C#
public class ApiException : Exception, ISerializable
Remarks

When this exception is thrown, it indicates that an error occurred processing the request, but that the error contains no sensitive data and should be communicated to the API consumer.

Constructors

| Improve this Doc View Source

ApiException()

Initializes a new instance of the ApiException class

C#
public ApiException()
| Improve this Doc View Source

ApiException(Int32)

Initializes a new instance of the ApiException class

C#
public ApiException(int errorCode)
Parameters
errorCodeInt32

A unique error code for the error that occurred

| Improve this Doc View Source

ApiException(String)

Initializes a new instance of the ApiException class

C#
public ApiException(string message)
Parameters
messageString

A message explaining the exception

| Improve this Doc View Source

ApiException(String, Exception)

Initializes a new instance of the ApiException class

C#
public ApiException(string message, Exception inner)
Parameters
messageString

A message explaining the exception

innerException

The inner exception that caused this one

| Improve this Doc View Source

ApiException(String, Exception, Int32)

Initializes a new instance of the ApiException class

C#
public ApiException(string message, Exception inner, int errorCode)
Parameters
messageString

A message explaining the exception

innerException

The inner exception that caused this one

errorCodeInt32

A unique error code for the error that occurred

| Improve this Doc View Source

ApiException(String, Int32)

Initializes a new instance of the ApiException class

C#
public ApiException(string message, int errorCode)
Parameters
messageString

A message explaining the exception

errorCodeInt32

A unique error code for the error that occurred

Properties

| Improve this Doc View Source

ErrorCode

Gets or sets a unique code for the error that occurred

C#
public int ErrorCode { get; set; }
Property Value
Int32

Implements

System.Runtime.Serialization.ISerializable
  • Improve this Doc
  • View Source
Back to top Generated by DocFX