View Source

Interface ITrackedReferencesRepository

Namespace: Umbraco.Cms.Core.Persistence.Repositories

Assembly: Umbraco.Core.dll

Syntax

public interface ITrackedReferencesRepository

Methods

GetPagedDescendantsInReferences(Guid, Int64, Int64, Boolean, out Int64)

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.
System.Int64	skip	The amount of items to skip.
System.Int64	take	The amount of items to take.
System.Boolean	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).
System.Int64	totalRecords	The total count of descending items.

Returns

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

GetPagedDescendantsInReferences(Int32, Int64, Int32, Boolean, out Int64)

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

Declaration

IEnumerable<RelationItem> GetPagedDescendantsInReferences(int parentId, long pageIndex, int pageSize, bool filterMustBeIsDependency, out long totalRecords)

Parameters

Type	Name	Description
System.Int32	parentId	The unique identifier of the parent to retrieve descendants for.
System.Int64	pageIndex	The page index.
System.Int32	pageSize	The page size.
System.Boolean	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).
System.Int64	totalRecords	The total count of descending items.

Returns

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

GetPagedDescendantsInReferences(Int32, Int64, Int64, Boolean, out Int64)

Declaration

IEnumerable<RelationItemModel> GetPagedDescendantsInReferences(int parentId, long skip, long take, bool filterMustBeIsDependency, out long totalRecords)

Parameters

Type	Name	Description
System.Int32	parentId
System.Int64	skip
System.Int64	take
System.Boolean	filterMustBeIsDependency
System.Int64	totalRecords

Returns

Type	Description
IEnumerable<RelationItemModel>

GetPagedItemsWithRelations(ISet<Guid>, Int64, Int64, Boolean, out Int64)

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.
System.Int64	skip	The amount of items to skip.
System.Int64	take	The amount of items to take.
System.Boolean	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).
System.Int64	totalRecords	The total count of the items in any kind of relation.

Returns

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

GetPagedItemsWithRelations(Int32[], Int64, Int32, Boolean, out Int64)

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

Declaration

IEnumerable<RelationItem> GetPagedItemsWithRelations(int[] ids, long pageIndex, int pageSize, bool filterMustBeIsDependency, out long totalRecords)

Parameters

Type	Name	Description
System.Int32[]	ids	The identifiers of the entities to check for relations.
System.Int64	pageIndex	The page index.
System.Int32	pageSize	The page size.
System.Boolean	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).
System.Int64	totalRecords	The total count of the items in any kind of relation.

Returns

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

GetPagedItemsWithRelations(Int32[], Int64, Int64, Boolean, out Int64)

Declaration

IEnumerable<RelationItemModel> GetPagedItemsWithRelations(int[] ids, long skip, long take, bool filterMustBeIsDependency, out long totalRecords)

Parameters

Type	Name	Description
System.Int32[]	ids
System.Int64	skip
System.Int64	take
System.Boolean	filterMustBeIsDependency
System.Int64	totalRecords

Returns

Type	Description
IEnumerable<RelationItemModel>

GetPagedRelationsForItem(Guid, Int64, Int64, Boolean, out Int64)

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.
System.Int64	skip	The amount of items to skip.
System.Int64	take	The amount of items to take.
System.Boolean	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).
System.Int64	totalRecords	The total count of the items with reference to the current item.

Returns

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

GetPagedRelationsForItem(Int32, Int64, Int32, Boolean, out Int64)

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<RelationItem> GetPagedRelationsForItem(int id, long pageIndex, int pageSize, bool filterMustBeIsDependency, out long totalRecords)

Parameters

Type	Name	Description
System.Int32	id	The identifier of the entity to retrieve relations for.
System.Int64	pageIndex	The page index.
System.Int32	pageSize	The page size.
System.Boolean	filterMustBeIsDependency	A boolean indicating whether to filter only the RelationTypes which are dependencies (isDependency field is set to true).
System.Int64	totalRecords	The total count of the items with reference to the current item.

Returns

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

GetPagedRelationsForItem(Int32, Int64, Int64, Boolean, out Int64)

Declaration

IEnumerable<RelationItemModel> GetPagedRelationsForItem(int id, long skip, long take, bool filterMustBeIsDependency, out long totalRecords)

Parameters

Type	Name	Description
System.Int32	id
System.Int64	skip
System.Int64	take
System.Boolean	filterMustBeIsDependency
System.Int64	totalRecords

Returns

Type	Description
IEnumerable<RelationItemModel>