View Source

Class CleanFolderResult

Represents the result of a folder cleaning operation.

Inheritance

object

Namespace: Umbraco.Cms.Core.IO

Assembly: Umbraco.Core.dll

Syntax

public class CleanFolderResult

Properties

Errors

Gets the collection of errors that occurred during the clean folder operation.

Declaration

public IReadOnlyCollection<CleanFolderResult.Error>? Errors { get; }

Property Value

Type	Description
IReadOnlyCollection<CleanFolderResult.Error>

Status

Gets the status of the clean folder operation.

Declaration

public CleanFolderResultStatus Status { get; }

Property Value

Type	Description
CleanFolderResultStatus

Methods

FailedAsDoesNotExist()

Creates a failed clean folder result indicating the folder does not exist.

Declaration

public static CleanFolderResult FailedAsDoesNotExist()

Returns

Type	Description
CleanFolderResult	A CleanFolderResult indicating the folder does not exist.

FailedWithErrors(List<Error>)

Creates a failed clean folder result with the specified errors.

Declaration

public static CleanFolderResult FailedWithErrors(List<CleanFolderResult.Error> errors)

Parameters

Type	Name	Description
List<CleanFolderResult.Error>	errors	The list of errors that occurred during the operation.

Returns

Type	Description
CleanFolderResult	A CleanFolderResult containing the errors.

Success()

Creates a successful clean folder result.

Declaration

public static CleanFolderResult Success()

Returns

Type	Description
CleanFolderResult	A CleanFolderResult indicating success.