View Source

Interface ITrackedReferencesRepository

Namespace: Umbraco.Cms.Core.Persistence.Repositories

Assembly: Umbraco.Core.dll

Syntax

public interface ITrackedReferencesRepository

Methods

GetPagedDescendantsInReferences(Guid, long, long, bool, out long)

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

Declaration

IEnumerable<RelationItemModel> GetPagedDescendantsInReferences(Guid parentKey, long skip, long take, bool filterMustBeIsDependency, out long totalRecords)

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).
long	totalRecords	The total count of descending items.

Returns

Type	Description
IEnumerable<RelationItemModel>	An enumerable list of RelationItem objects.

GetPagedItemsWithRelations(ISet<Guid>, long, long, bool, out long)

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

Declaration

IEnumerable<RelationItemModel> GetPagedItemsWithRelations(ISet<Guid> keys, long skip, long take, bool filterMustBeIsDependency, out long totalRecords)

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).
long	totalRecords	The total count of the items in any kind of relation.

Returns

Type	Description
IEnumerable<RelationItemModel>	An enumerable list of RelationItem objects.

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

Gets a paged collection of node keys that have dependant references.

Declaration

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

Parameters

Type	Name	Description
ISet<Guid>	keys	The keys to check for relations.
Guid	nodeObjectTypeId	The node object Id.
long	skip	The amount of items to skip.
long	take	The amount of items to take.

Returns

Type	Description
Task<PagedModel<Guid>>

GetPagedRelationsForItem(Guid, long, long, bool, out long)

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

Declaration

IEnumerable<RelationItemModel> GetPagedRelationsForItem(Guid key, long skip, long take, bool filterMustBeIsDependency, out long totalRecords)

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).
long	totalRecords	The total count of the items with reference to the current item.

Returns

Type	Description
IEnumerable<RelationItemModel>	An enumerable list of RelationItem objects.

GetPagedRelationsForRecycleBin(Guid, long, long, bool, out long)

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

Declaration

IEnumerable<RelationItemModel> GetPagedRelationsForRecycleBin(Guid objectTypeKey, long skip, long take, bool filterMustBeIsDependency, out long totalRecords)

Parameters

Type	Name	Description
Guid	objectTypeKey	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).
long	totalRecords	The total count of the items with reference to the current item.

Returns

Type	Description
IEnumerable<RelationItemModel>	An enumerable list of RelationItem objects.