View Source

Class ProcessInstructionsResult

Defines a result object for the ProcessInstructions(CacheRefresherCollection, CancellationToken, string, int) operation.

Inheritance

object

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public class ProcessInstructionsResult

Properties

View Source

InstructionsWerePruned

Gets a value indicating whether the instructions were pruned.

Declaration

[Obsolete("Instruction pruning has been moved to a separate background job. Scheduled for removal in Umbraco 18.")]
public bool InstructionsWerePruned { get; }

Property Value

Type	Description
bool

View Source

LastId

Gets the ID of the last instruction that was processed.

Declaration

public int LastId { get; }

Property Value

Type	Description
int

View Source

NumberOfInstructionsProcessed

Gets the number of instructions that were processed.

Declaration

public int NumberOfInstructionsProcessed { get; }

Property Value

Type	Description
int

Methods

View Source

AsCompleted(int, int)

Creates a new completed result with the specified number of instructions processed and last ID.

Declaration

public static ProcessInstructionsResult AsCompleted(int numberOfInstructionsProcessed, int lastId)

Parameters

Type	Name	Description
int	numberOfInstructionsProcessed	The number of instructions that were processed.
int	lastId	The ID of the last instruction that was processed.

Returns

Type	Description
ProcessInstructionsResult	A new ProcessInstructionsResult instance.

View Source

AsCompletedAndPruned(int, int)

Creates a new completed result with the specified number of instructions processed, last ID, and pruned flag set to true.

Declaration

[Obsolete("Instruction pruning has been moved to a separate background job. Scheduled for removal in Umbraco 18.")]
public static ProcessInstructionsResult AsCompletedAndPruned(int numberOfInstructionsProcessed, int lastId)

Parameters

Type	Name	Description
int	numberOfInstructionsProcessed	The number of instructions that were processed.
int	lastId	The ID of the last instruction that was processed.

Returns

Type	Description
ProcessInstructionsResult	A new ProcessInstructionsResult instance with the pruned flag set.