Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IDynamicRootQueryStep

    Defines a query step that can filter or traverse the content tree during dynamic root resolution.

    Namespace: Umbraco.Cms.Core.DynamicRoot.QuerySteps
    Assembly: Umbraco.Core.dll
    Syntax
    public interface IDynamicRootQueryStep

    Properties

    View Source

    SupportedDirectionAlias

    Gets the direction alias that this query step supports (e.g., "NearestAncestorOrSelf", "FurthestDescendantOrSelf").

    Declaration
    string SupportedDirectionAlias { get; }
    Property Value
    Type Description
    string

    Methods

    View Source

    ExecuteAsync(ICollection<Guid>, DynamicRootQueryStep)

    Executes the query step on the specified origin content items.

    Declaration
    Task<Attempt<ICollection<Guid>>> ExecuteAsync(ICollection<Guid> origins, DynamicRootQueryStep filter)
    Parameters
    Type Name Description
    ICollection<Guid> origins

    The collection of content keys to use as starting points for this query step.

    DynamicRootQueryStep filter

    The query step configuration containing the alias and document type filter criteria.

    Returns
    Type Description
    Task<Attempt<ICollection<Guid>>>

    A task representing the asynchronous operation, containing an Attempt<TResult> with the filtered content keys. Returns a failed attempt if this query step does not support the specified alias.

    • View Source
    In this article
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX