WebFarmHelper.RegisterTask<T> Method (Boolean, WebFarmTaskOptimizeActionEnum)

Registers the given web farm task.

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 12.0.0

Syntax

public static void RegisterTask<T>(
	bool isMemoryTask = false,
	WebFarmTaskOptimizeActionEnum webFarmTaskOptimize = WebFarmTaskOptimizeActionEnum.None
)
where T : new(), WebFarmTaskBase

Parameters

isMemoryTask (Optional)

Type: System.Boolean
Indicates if the task modifies only memory. Memory tasks can be deleted on application start.

webFarmTaskOptimize (Optional)

Type: CMS.Core.WebFarmTaskOptimizeActionEnum
Determines type of optimization which is used for reducing number of generated web farm tasks of particular type.

Type Parameters

T

Exceptions

Exception	Condition
ArgumentException	Thrown when task to be registered does not have parameterless constructor.
InvalidOperationException	Thrown when task has been already registered.