View Source

Interface IRecycleBinNavigationQueryService

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

Namespace: Umbraco.Cms.Core.Services.Navigation

Assembly: Umbraco.Core.dll

Syntax

public interface IRecycleBinNavigationQueryService

Remarks

This interface defines methods for traversing and querying the recycle bin navigation structure, including parent, children, descendants, ancestors, and siblings.

Methods

TryGetAncestorsKeysInBin(Guid, out IEnumerable<Guid>)

Attempts to get all ancestor node keys of a child node in the recycle bin.

Declaration

bool TryGetAncestorsKeysInBin(Guid childKey, out IEnumerable<Guid> ancestorsKeys)

Parameters

Type	Name	Description
Guid	childKey	The unique identifier of the child node.
IEnumerable<Guid>	ancestorsKeys	When this method returns, contains the collection of ancestor node keys (parent, grandparent, etc.); or an empty collection if the child doesn't exist.

Returns

Type	Description
bool	true if the child node exists in the recycle bin; otherwise, false.

TryGetChildrenKeysInBin(Guid, out IEnumerable<Guid>)

Attempts to get all child node keys of a parent node in the recycle bin.

Declaration

bool TryGetChildrenKeysInBin(Guid parentKey, out IEnumerable<Guid> childrenKeys)

Parameters

Type	Name	Description
Guid	parentKey	The unique identifier of the parent node.
IEnumerable<Guid>	childrenKeys	When this method returns, contains the collection of child node keys ordered by sort order; or an empty collection if the parent doesn't exist.

Returns

Type	Description
bool	true if the parent node exists in the recycle bin; otherwise, false.

TryGetDescendantsKeysInBin(Guid, out IEnumerable<Guid>)

Attempts to get all descendant node keys of a parent node in the recycle bin.

Declaration

bool TryGetDescendantsKeysInBin(Guid parentKey, out IEnumerable<Guid> descendantsKeys)

Parameters

Type	Name	Description
Guid	parentKey	The unique identifier of the parent node.
IEnumerable<Guid>	descendantsKeys	When this method returns, contains the collection of all descendant node keys; or an empty collection if the parent doesn't exist.

Returns

Type	Description
bool	true if the parent node exists in the recycle bin; otherwise, false.

TryGetDescendantsKeysOrSelfKeysInBin(Guid, out IEnumerable<Guid>)

Attempts to get all descendant node keys including the node itself in the recycle bin.

Declaration

bool TryGetDescendantsKeysOrSelfKeysInBin(Guid childKey, out IEnumerable<Guid> descendantsOrSelfKeys)

Parameters

Type	Name	Description
Guid	childKey	The unique identifier of the node.
IEnumerable<Guid>	descendantsOrSelfKeys	When this method returns, contains the node's key followed by all its descendant keys; or an empty collection if the node doesn't exist.

Returns

Type	Description
bool	true if the node exists in the recycle bin; otherwise, false.

TryGetParentKeyInBin(Guid, out Guid?)

Attempts to get the parent key of a child node in the recycle bin.

Declaration

bool TryGetParentKeyInBin(Guid childKey, out Guid? parentKey)

Parameters

Type	Name	Description
Guid	childKey	The unique identifier of the child node.
Guid?	parentKey	When this method returns, contains the parent's unique identifier if the child exists; otherwise, null. The value will be null if the child is at bin root level.

Returns

Type	Description
bool	true if the child node exists in the recycle bin; otherwise, false.

TryGetSiblingsKeysInBin(Guid, out IEnumerable<Guid>)

Attempts to get all sibling node keys of a node in the recycle bin.

Declaration

bool TryGetSiblingsKeysInBin(Guid key, out IEnumerable<Guid> siblingsKeys)

Parameters

Type	Name	Description
Guid	key	The unique identifier of the node.
IEnumerable<Guid>	siblingsKeys	When this method returns, contains the collection of sibling node keys (excluding the node itself), ordered by sort order; or an empty collection if the node doesn't exist.

Returns

Type	Description
bool	true if the node exists in the recycle bin; otherwise, false.