View Source

Interface IRecycleBinNavigationManagementService

Placeholder for sharing logic between the document and media navigation services for managing the recycle bin navigation structure.

Namespace: Umbraco.Cms.Core.Services.Navigation

Assembly: Umbraco.Core.dll

Syntax

public interface IRecycleBinNavigationManagementService

Remarks

This interface defines methods for managing items in the recycle bin, including rebuilding, removing, and restoring items.

Methods

RebuildBinAsync()

Rebuilds the recycle bin navigation structure by fetching the latest trashed nodes from the underlying repository.

Declaration

Task RebuildBinAsync()

Returns

Type	Description
Task	A task representing the asynchronous rebuild operation.

RemoveFromBin(Guid)

Permanently removes a node and all of its descendants from the recycle bin navigation structure.

Declaration

bool RemoveFromBin(Guid key)

Parameters

Type	Name	Description
Guid	key	The unique identifier of the node to remove.

Returns

Type	Description
bool	true if the node and its descendants were successfully removed from the recycle bin; otherwise, false.

RestoreFromBin(Guid, Guid?)

Restores a node and all of its descendants from the recycle bin navigation structure and moves them back to the main navigation structure. The node can be restored to a specified target parent or to the root level if no parent is specified.

Declaration

bool RestoreFromBin(Guid key, Guid? targetParentKey = null)

Parameters

Type	Name	Description
Guid	key	The unique identifier of the node to restore from the recycle bin navigation structure.
Guid?	targetParentKey	The unique identifier of the target parent node in the main navigation structure to which the node should be restored. If null, the node will be restored to the root level.

Returns

Type	Description
bool	true if the node and its descendants were successfully restored to the main navigation structure; otherwise, false.