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
bool
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
string contentTypeAlias
IEnumerable<Guid> ancestorsKeys
Returns
Type Description
bool
View Source

TryGetAncestorsOrSelfKeys(Guid, out IEnumerable<Guid>)

Declaration
bool TryGetAncestorsOrSelfKeys(Guid childKey, out IEnumerable<Guid> ancestorsOrSelfKeys)
Parameters
Type Name Description
Guid childKey
IEnumerable<Guid> ancestorsOrSelfKeys
Returns
Type Description
bool
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
bool
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
string contentTypeAlias
IEnumerable<Guid> childrenKeys
Returns
Type Description
bool
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
bool
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
string contentTypeAlias
IEnumerable<Guid> descendantsKeys
Returns
Type Description
bool
View Source

TryGetDescendantsKeysOrSelfKeys(Guid, out IEnumerable<Guid>)

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

TryGetLevel(Guid, out int?)

Declaration
bool TryGetLevel(Guid contentKey, out int? level)
Parameters
Type Name Description
Guid contentKey
int? level
Returns
Type Description
bool
View Source

TryGetParentKey(Guid, out Guid?)

Declaration
bool TryGetParentKey(Guid childKey, out Guid? parentKey)
Parameters
Type Name Description
Guid childKey
Guid? parentKey
Returns
Type Description
bool
View Source

TryGetRootKeys(out IEnumerable<Guid>)

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

TryGetRootKeysOfType(string, out IEnumerable<Guid>)

Declaration
bool TryGetRootKeysOfType(string contentTypeAlias, out IEnumerable<Guid> rootKeys)
Parameters
Type Name Description
string contentTypeAlias
IEnumerable<Guid> rootKeys
Returns
Type Description
bool
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
bool
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
string contentTypeAlias
IEnumerable<Guid> siblingsKeys
Returns
Type Description
bool