View Source

Interface INavigationQueryService

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

Namespace: Umbraco.Cms.Core.Services.Navigation
Assembly: Umbraco.Core.dll
Syntax
public interface INavigationQueryService

Methods

View Source

TryGetAncestorsKeys(Guid, out IEnumerable<Guid>)

Declaration
bool TryGetAncestorsKeys(Guid childKey, out IEnumerable<Guid> ancestorsKeys)
Parameters
Type Name Description
Guid childKey
IEnumerable<Guid> ancestorsKeys
Returns
Type Description
System.Boolean
View Source

TryGetAncestorsKeysOfType(Guid, String, out IEnumerable<Guid>)

Declaration
bool TryGetAncestorsKeysOfType(Guid parentKey, string contentTypeAlias, out IEnumerable<Guid> ancestorsKeys)
Parameters
Type Name Description
Guid parentKey
System.String contentTypeAlias
IEnumerable<Guid> ancestorsKeys
Returns
Type Description
System.Boolean
View Source

TryGetAncestorsOrSelfKeys(Guid, out IEnumerable<Guid>)

Declaration
virtual bool TryGetAncestorsOrSelfKeys(Guid childKey, out IEnumerable<Guid> ancestorsOrSelfKeys)
Parameters
Type Name Description
Guid childKey
IEnumerable<Guid> ancestorsOrSelfKeys
Returns
Type Description
System.Boolean
View Source

TryGetChildrenKeys(Guid, out IEnumerable<Guid>)

Declaration
bool TryGetChildrenKeys(Guid parentKey, out IEnumerable<Guid> childrenKeys)
Parameters
Type Name Description
Guid parentKey
IEnumerable<Guid> childrenKeys
Returns
Type Description
System.Boolean
View Source

TryGetChildrenKeysOfType(Guid, String, out IEnumerable<Guid>)

Declaration
bool TryGetChildrenKeysOfType(Guid parentKey, string contentTypeAlias, out IEnumerable<Guid> childrenKeys)
Parameters
Type Name Description
Guid parentKey
System.String contentTypeAlias
IEnumerable<Guid> childrenKeys
Returns
Type Description
System.Boolean
View Source

TryGetDescendantsKeys(Guid, out IEnumerable<Guid>)

Declaration
bool TryGetDescendantsKeys(Guid parentKey, out IEnumerable<Guid> descendantsKeys)
Parameters
Type Name Description
Guid parentKey
IEnumerable<Guid> descendantsKeys
Returns
Type Description
System.Boolean
View Source

TryGetDescendantsKeysOfType(Guid, String, out IEnumerable<Guid>)

Declaration
bool TryGetDescendantsKeysOfType(Guid parentKey, string contentTypeAlias, out IEnumerable<Guid> descendantsKeys)
Parameters
Type Name Description
Guid parentKey
System.String contentTypeAlias
IEnumerable<Guid> descendantsKeys
Returns
Type Description
System.Boolean
View Source

TryGetDescendantsKeysOrSelfKeys(Guid, out IEnumerable<Guid>)

Declaration
virtual bool TryGetDescendantsKeysOrSelfKeys(Guid parentKey, out IEnumerable<Guid> descendantsOrSelfKeys)
Parameters
Type Name Description
Guid parentKey
IEnumerable<Guid> descendantsOrSelfKeys
Returns
Type Description
System.Boolean
View Source

TryGetLevel(Guid, out Nullable<Int32>)

Declaration
bool TryGetLevel(Guid contentKey, out int? level)
Parameters
Type Name Description
Guid contentKey
System.Nullable<System.Int32> level
Returns
Type Description
System.Boolean
View Source

TryGetParentKey(Guid, out Nullable<Guid>)

Declaration
bool TryGetParentKey(Guid childKey, out Guid? parentKey)
Parameters
Type Name Description
Guid childKey
System.Nullable<Guid> parentKey
Returns
Type Description
System.Boolean
View Source

TryGetRootKeys(out IEnumerable<Guid>)

Declaration
bool TryGetRootKeys(out IEnumerable<Guid> rootKeys)
Parameters
Type Name Description
IEnumerable<Guid> rootKeys
Returns
Type Description
System.Boolean
View Source

TryGetRootKeysOfType(String, out IEnumerable<Guid>)

Declaration
bool TryGetRootKeysOfType(string contentTypeAlias, out IEnumerable<Guid> rootKeys)
Parameters
Type Name Description
System.String contentTypeAlias
IEnumerable<Guid> rootKeys
Returns
Type Description
System.Boolean
View Source

TryGetSiblingsKeys(Guid, out IEnumerable<Guid>)

Declaration
bool TryGetSiblingsKeys(Guid key, out IEnumerable<Guid> siblingsKeys)
Parameters
Type Name Description
Guid key
IEnumerable<Guid> siblingsKeys
Returns
Type Description
System.Boolean
View Source

TryGetSiblingsKeysOfType(Guid, String, out IEnumerable<Guid>)

Declaration
bool TryGetSiblingsKeysOfType(Guid key, string contentTypeAlias, out IEnumerable<Guid> siblingsKeys)
Parameters
Type Name Description
Guid key
System.String contentTypeAlias
IEnumerable<Guid> siblingsKeys
Returns
Type Description
System.Boolean