Interface IBackgroundTaskMessage

A message generated by a background task.

Namespace: Mediachase.Commerce.BackgroundTasks
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
Syntax
public interface IBackgroundTaskMessage

Properties

Exception

Gets the exception resulting in failure of the task, or null if the message is not a failure message.

Declaration
Exception Exception { get; }
Property Value
Type Description
System.Exception

ExceptionMessage

Gets the exception message from Exception, or null if Exception is null.

Declaration
string ExceptionMessage { get; }
Property Value
Type Description
System.String

ExceptionStackTrace

Gets the stack trace from Exception, or null if Exception is null.

Declaration
string ExceptionStackTrace { get; }
Property Value
Type Description
System.String

Message

Gets the content of the message.

Declaration
string Message { get; }
Property Value
Type Description
System.String

MessageType

Gets the type of the message.

Declaration
BackgroundTaskMessageType MessageType { get; }
Property Value
Type Description
BackgroundTaskMessageType

StageCount

Gets the number of stages in the task.

Declaration
int StageCount { get; }
Property Value
Type Description
System.Int32

StageIndex

Gets the index (zero based) of the current stage.

Declaration
int StageIndex { get; }
Property Value
Type Description
System.Int32

StageName

Gets the name of the current stage of processing.

Declaration
string StageName { get; }
Property Value
Type Description
System.String

StageProgress

Gets the current progress within the current stage of execution.

Declaration
int StageProgress { get; }
Property Value
Type Description
System.Int32

StageTotalProgress

Gets the value of StageProgress that indicates completion of the current stage.

Declaration
int StageTotalProgress { get; }
Property Value
Type Description
System.Int32

TimestampUtc

Gets the timestamp of the message, in UTC.

Declaration
DateTime TimestampUtc { get; }
Property Value
Type Description
System.DateTime

Extension Methods