IProgressReport Interface

Represents the event based progress tracking system.

Namespace: Ingeniux.CMS.Messaging
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169

Syntax

public interface IProgressReport : IDisposable

Public Interface IProgressReport
	Inherits IDisposable

public interface class IProgressReport : IDisposable

type IProgressReport =  
    interface
        interface IDisposable
    end

The IProgressReport type exposes the following members.

Properties

	Name	Description
	CurrentProgress	Gets the current progress steps count
	CurrentProgressPercentage	Gets the current progress as percent times 100
	Started	Gets whether the progress has started

Methods

	Name	Description
	Complete	Completes the progress, set the progression as 100%
	DataProgress	Make on step on progress to save data to content store. The progress is counted differently
	Progress	Make one step in the progress, with operational message
	SetDataStep	Sets how many data steps to complete the progress
	Start	Starts the progress, cannot be restarted

Events

	Name	Description
	Completed	Event fired when progress completed
	Progressed	Event fired when making one step forward in progress
	ProgressStarted	Event fired when progress started