View Source

Class ByKeyDynamicRootOriginFinder

An origin finder that locates a content item by its unique key. This finder handles the "ByKey" origin type and validates that the entity exists and is of an allowed type.

Inheritance

object

Namespace: Umbraco.Cms.Core.DynamicRoot.Origin

Assembly: Umbraco.Core.dll

Syntax

public class ByKeyDynamicRootOriginFinder : IDynamicRootOriginFinder

Constructors

ByKeyDynamicRootOriginFinder(IEntityService)

Initializes a new instance of the ByKeyDynamicRootOriginFinder class.

Declaration

public ByKeyDynamicRootOriginFinder(IEntityService entityService)

Parameters

Type	Name	Description
IEntityService	entityService	The entity service used to retrieve entities by key.

Properties

SupportedOriginType

Gets or sets the origin type alias that this finder supports.

Declaration

protected virtual string SupportedOriginType { get; set; }

Property Value

Type	Description
string

Methods

FindOriginKey(DynamicRootNodeQuery)

Attempts to find the origin content key based on the specified query.

Declaration

public virtual Guid? FindOriginKey(DynamicRootNodeQuery query)

Parameters

Type	Name	Description
DynamicRootNodeQuery	query

Returns

Type	Description
Guid?	The unique identifier of the origin content, or null if this finder does not support the query or cannot find the origin.