Interface ITrackedReferencesService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface ITrackedReferencesService

Methods

View Source

GetPagedDescendantsInReferences(Int32, Int64, Int32, Boolean)

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

Declaration

PagedResult<RelationItem> GetPagedDescendantsInReferences(int parentId, long pageIndex, int pageSize, bool filterMustBeIsDependency)

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).

Returns

Type	Description
PagedResult<RelationItem>	A paged result of RelationItem objects.

View Source

GetPagedDescendantsInReferences(Int32, Int64, Int64, Boolean)

Declaration

PagedModel<RelationItemModel> GetPagedDescendantsInReferences(int parentId, long skip, long take, bool filterMustBeIsDependency)

Parameters

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

Returns

Type	Description
PagedModel<RelationItemModel>

View Source

GetPagedDescendantsInReferencesAsync(Guid, Int64, Int64, Boolean)

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

Declaration

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.
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).

Returns

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

View Source

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

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

Declaration

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

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).

Returns

Type	Description
PagedResult<RelationItem>	A paged result of RelationItem objects.

View Source

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

Declaration

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

Parameters

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

Returns

Type	Description
PagedModel<RelationItemModel>

View Source

GetPagedItemsWithRelationsAsync(ISet<Guid>, Int64, Int64, Boolean)

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.
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).

Returns

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

View Source

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

Declaration

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

Parameters

Type	Name	Description
ISet<Guid>	keys
Guid	nodeObjectTypeId
System.Int64	skip
System.Int64	take

Returns

Type	Description
Task<PagedModel<Guid>>

View Source

GetPagedRelationsForItem(Int32, Int64, Int32, Boolean)

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

PagedResult<RelationItem> GetPagedRelationsForItem(int id, long pageIndex, int pageSize, bool filterMustBeIsDependency)

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).

Returns

Type	Description
PagedResult<RelationItem>	A paged result of RelationItem objects.

View Source

GetPagedRelationsForItem(Int32, Int64, Int64, Boolean)

Declaration

PagedModel<RelationItemModel> GetPagedRelationsForItem(int id, long skip, long take, bool filterMustBeIsDependency)

Parameters

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

Returns

Type	Description
PagedModel<RelationItemModel>

View Source

GetPagedRelationsForItemAsync(Guid, Int64, Int64, Boolean)

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<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.
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).

Returns

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

View Source

GetPagedRelationsForRecycleBinAsync(UmbracoObjectTypes, Int64, Int64, Boolean)

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

Declaration

virtual 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).
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).

Returns

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