View Source

Interface ITrackedReferencesService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface ITrackedReferencesService

Methods

GetPagedDescendantsInReferencesAsync(Guid, long, long, bool)

Gets a paged result of the descending items that have any references, given a parent id.

Declaration

[Obsolete("Use GetPagedDescendantsInReferencesAsync which returns an Attempt with operation status. Scheduled for removal in Umbraco 19.")]
Task<PagedModel<RelationItemModel>> GetPagedDescendantsInReferencesAsync(Guid parentKey, long skip, long take, bool filterMustBeIsDependency)

Parameters

Type	Name	Description
Guid	parentKey	The unique identifier of the parent to retrieve descendants for.
long	skip	The amount of items to skip
long	take	The amount of items to take.
bool	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).

Returns

Type	Description
Task<PagedModel<RelationItemModel>>	A paged result of RelationItemModel objects.

GetPagedDescendantsInReferencesAsync(Guid, UmbracoObjectTypes, long, long, bool)

Gets a paged result of the descending items that have any references, given a parent id.

Declaration

Task<Attempt<PagedModel<RelationItemModel>, GetReferencesOperationStatus>> GetPagedDescendantsInReferencesAsync(Guid parentKey, UmbracoObjectTypes objectType, long skip, long take, bool filterMustBeIsDependency)

Parameters

Type	Name	Description
Guid	parentKey	The unique identifier of the parent to retrieve descendants for.
UmbracoObjectTypes	objectType	The Umbraco object type of the parent.
long	skip	The amount of items to skip
long	take	The amount of items to take.
bool	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).

Returns

Type	Description
Task<Attempt<PagedModel<RelationItemModel>, GetReferencesOperationStatus>>	An Attempt wrapping a paged result of RelationItemModel objects.

GetPagedItemsWithRelationsAsync(ISet<Guid>, long, long, bool)

Gets a paged result of items used in any kind of relation from selected integer ids.

Declaration

Task<PagedModel<RelationItemModel>> GetPagedItemsWithRelationsAsync(ISet<Guid> keys, long skip, long take, bool filterMustBeIsDependency)

Parameters

Type	Name	Description
ISet<Guid>	keys	The identifiers of the entities to check for relations.
long	skip	The amount of items to skip
long	take	The amount of items to take.
bool	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).

Returns

Type	Description
Task<PagedModel<RelationItemModel>>	A paged result of RelationItemModel objects.

GetPagedKeysWithDependentReferencesAsync(ISet<Guid>, Guid, long, long)

Declaration

Task<PagedModel<Guid>> GetPagedKeysWithDependentReferencesAsync(ISet<Guid> keys, Guid nodeObjectTypeId, long skip, long take)

Parameters

Type	Name	Description
ISet<Guid>	keys
Guid	nodeObjectTypeId
long	skip
long	take

Returns

Type	Description
Task<PagedModel<Guid>>

GetPagedRelationsForItemAsync(Guid, long, long, bool)

Gets a paged result of items which are in relation with the current item. Basically, shows the items which depend on the current item.

Declaration

[Obsolete("Use GetPagedRelationsForItemAsync which returns an Attempt with operation status. Scheduled for removal in Umbraco 19.")]
Task<PagedModel<RelationItemModel>> GetPagedRelationsForItemAsync(Guid key, long skip, long take, bool filterMustBeIsDependency)

Parameters

Type	Name	Description
Guid	key	The identifier of the entity to retrieve relations for.
long	skip	The amount of items to skip
long	take	The amount of items to take.
bool	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).

Returns

Type	Description
Task<PagedModel<RelationItemModel>>	A paged result of RelationItemModel objects.

GetPagedRelationsForItemAsync(Guid, UmbracoObjectTypes, long, long, bool)

Gets a paged result of items which are in relation with the current item. Basically, shows the items which depend on the current item.

Declaration

Task<Attempt<PagedModel<RelationItemModel>, GetReferencesOperationStatus>> GetPagedRelationsForItemAsync(Guid key, UmbracoObjectTypes objectType, long skip, long take, bool filterMustBeIsDependency)

Parameters

Type	Name	Description
Guid	key	The identifier of the entity to retrieve relations for.
UmbracoObjectTypes	objectType	The Umbraco object type of the parent.
long	skip	The amount of items to skip
long	take	The amount of items to take.
bool	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).

Returns

Type	Description
Task<Attempt<PagedModel<RelationItemModel>, GetReferencesOperationStatus>>	A paged result of RelationItemModel objects.

GetPagedRelationsForRecycleBinAsync(UmbracoObjectTypes, long, long, bool)

Gets a paged result of items which are in relation with an item in the recycle bin.

Declaration

Task<PagedModel<RelationItemModel>> GetPagedRelationsForRecycleBinAsync(UmbracoObjectTypes objectType, long skip, long take, bool filterMustBeIsDependency)

Parameters

Type	Name	Description
UmbracoObjectTypes	objectType	The Umbraco object type that has recycle bin support (currently Document or Media).
long	skip	The amount of items to skip
long	take	The amount of items to take.
bool	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).

Returns

Type	Description
Task<PagedModel<RelationItemModel>>	A paged result of RelationItemModel objects.