View Source

Interface IDynamicRootRepository

Provides data access operations for dynamic root query steps, supporting ancestor and descendant traversal with document type filtering.

Namespace: Umbraco.Cms.Core.DynamicRoot.QuerySteps

Assembly: Umbraco.Core.dll

Syntax

public interface IDynamicRootRepository

Methods

FurthestAncestorOrSelfAsync(IEnumerable<Guid>, DynamicRootQueryStep)

Finds the furthest (topmost) ancestor or self that matches the query step criteria.

Declaration

Task<Guid?> FurthestAncestorOrSelfAsync(IEnumerable<Guid> origins, DynamicRootQueryStep queryStep)

Parameters

Type	Name	Description
IEnumerable<Guid>	origins	The collection of content keys to start the search from.
DynamicRootQueryStep	queryStep	The query step containing document type filter criteria.

Returns

Type	Description
Task<Guid?>	A task representing the asynchronous operation, containing the key of the furthest matching ancestor or self, or null if none found.

FurthestDescendantOrSelfAsync(ICollection<Guid>, DynamicRootQueryStep)

Finds the furthest (deepest) descendants or self that match the query step criteria.

Declaration

Task<ICollection<Guid>> FurthestDescendantOrSelfAsync(ICollection<Guid> origins, DynamicRootQueryStep queryStep)

Parameters

Type	Name	Description
ICollection<Guid>	origins	The collection of content keys to start the search from.
DynamicRootQueryStep	queryStep	The query step containing document type filter criteria.

Returns

Type	Description
Task<ICollection<Guid>>	A task representing the asynchronous operation, containing a collection of keys for the furthest matching descendants or self.

NearestAncestorOrSelfAsync(IEnumerable<Guid>, DynamicRootQueryStep)

Finds the nearest (closest to origin) ancestor or self that matches the query step criteria.

Declaration

Task<Guid?> NearestAncestorOrSelfAsync(IEnumerable<Guid> origins, DynamicRootQueryStep queryStep)

Parameters

Type	Name	Description
IEnumerable<Guid>	origins	The collection of content keys to start the search from.
DynamicRootQueryStep	queryStep	The query step containing document type filter criteria.

Returns

Type	Description
Task<Guid?>	A task representing the asynchronous operation, containing the key of the nearest matching ancestor or self, or null if none found.

NearestDescendantOrSelfAsync(ICollection<Guid>, DynamicRootQueryStep)

Finds the nearest (closest to origin) descendants or self that match the query step criteria.

Declaration

Task<ICollection<Guid>> NearestDescendantOrSelfAsync(ICollection<Guid> origins, DynamicRootQueryStep queryStep)

Parameters

Type	Name	Description
ICollection<Guid>	origins	The collection of content keys to start the search from.
DynamicRootQueryStep	queryStep	The query step containing document type filter criteria.

Returns

Type	Description
Task<ICollection<Guid>>	A task representing the asynchronous operation, containing a collection of keys for the nearest matching descendants or self.