Table of Contents

Class MessageException

Namespace
ArcanaDevelopment.adTempus.Shared
Assembly
ArcanaDevelopment.adTempus.Shared.dll

Base class for exceptions that carry a Message.

public class MessageException : Exception
Inheritance
object
Exception
MessageException
Derived

Remarks

Most client API methods throw a MessageException for adTempus-specific errors (server connection failure, validation error, invalid operation, etc.). The ContainedMessage contains the Message for the error. Some errors return additional messages, contained in AdditionalMessages (which is a shortcut to ContainedMessage.AdditionalMessages).

Derived exception classes exist for particular scenarios so that they can be more easily caught and handled by the code, but the derived classes typically provide no additional members or information beyond what is available in the MessageException. The MessageCode can also be used to identify particular errors.

Constructors

MessageException(MessageExceptionType, Message) 

public MessageException(MessageExceptionType exceptionType, Message message)

Parameters

NameTypeDescription
exceptionType MessageExceptionType
message Message

MessageException(MessageExceptionType, Message, Exception) 

public MessageException(MessageExceptionType exceptionType, Message message, Exception innerException)

Parameters

NameTypeDescription
exceptionType MessageExceptionType
message Message
innerException Exception

Properties

AdditionalMessages

Additional messages related to the primary message

public MessageCollection AdditionalMessages { get; }

Property Value

MessageCollection

ContainedMessage

The Message for this exception

public Message ContainedMessage { get; protected set; }

Property Value

Message