Class ContentService
Implements the content service.
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public class ContentService : RepositoryService, IContentService, IContentServiceBase<IContent>, IContentServiceBase, IService
Constructors
View SourceContentService(ICoreScopeProvider, ILoggerFactory, IEventMessagesFactory, IDocumentRepository, IEntityRepository, IAuditRepository, IContentTypeRepository, IDocumentBlueprintRepository, ILanguageRepository, Lazy<IPropertyValidationService>, IShortStringHelper, ICultureImpactFactory)
Declaration
public ContentService(ICoreScopeProvider provider, ILoggerFactory loggerFactory, IEventMessagesFactory eventMessagesFactory, IDocumentRepository documentRepository, IEntityRepository entityRepository, IAuditRepository auditRepository, IContentTypeRepository contentTypeRepository, IDocumentBlueprintRepository documentBlueprintRepository, ILanguageRepository languageRepository, Lazy<IPropertyValidationService> propertyValidationService, IShortStringHelper shortStringHelper, ICultureImpactFactory cultureImpactFactory)
Parameters
Type | Name | Description |
---|---|---|
ICoreScopeProvider | provider | |
ILoggerFactory | loggerFactory | |
IEventMessagesFactory | eventMessagesFactory | |
IDocumentRepository | documentRepository | |
IEntityRepository | entityRepository | |
IAuditRepository | auditRepository | |
IContentTypeRepository | contentTypeRepository | |
IDocumentBlueprintRepository | documentBlueprintRepository | |
ILanguageRepository | languageRepository | |
Lazy<IPropertyValidationService> | propertyValidationService | |
IShortStringHelper | shortStringHelper | |
ICultureImpactFactory | cultureImpactFactory |
ContentService(ICoreScopeProvider, ILoggerFactory, IEventMessagesFactory, IDocumentRepository, IEntityRepository, IAuditRepository, IContentTypeRepository, IDocumentBlueprintRepository, ILanguageRepository, Lazy<IPropertyValidationService>, IShortStringHelper, ICultureImpactFactory, IUserIdKeyResolver)
Declaration
public ContentService(ICoreScopeProvider provider, ILoggerFactory loggerFactory, IEventMessagesFactory eventMessagesFactory, IDocumentRepository documentRepository, IEntityRepository entityRepository, IAuditRepository auditRepository, IContentTypeRepository contentTypeRepository, IDocumentBlueprintRepository documentBlueprintRepository, ILanguageRepository languageRepository, Lazy<IPropertyValidationService> propertyValidationService, IShortStringHelper shortStringHelper, ICultureImpactFactory cultureImpactFactory, IUserIdKeyResolver userIdKeyResolver)
Parameters
Type | Name | Description |
---|---|---|
ICoreScopeProvider | provider | |
ILoggerFactory | loggerFactory | |
IEventMessagesFactory | eventMessagesFactory | |
IDocumentRepository | documentRepository | |
IEntityRepository | entityRepository | |
IAuditRepository | auditRepository | |
IContentTypeRepository | contentTypeRepository | |
IDocumentBlueprintRepository | documentBlueprintRepository | |
ILanguageRepository | languageRepository | |
Lazy<IPropertyValidationService> | propertyValidationService | |
IShortStringHelper | shortStringHelper | |
ICultureImpactFactory | cultureImpactFactory | |
IUserIdKeyResolver | userIdKeyResolver |
ContentService(ICoreScopeProvider, ILoggerFactory, IEventMessagesFactory, IDocumentRepository, IEntityRepository, IAuditRepository, IContentTypeRepository, IDocumentBlueprintRepository, ILanguageRepository, Lazy<IPropertyValidationService>, IShortStringHelper, ICultureImpactFactory, IUserIdKeyResolver, PropertyEditorCollection)
Declaration
public ContentService(ICoreScopeProvider provider, ILoggerFactory loggerFactory, IEventMessagesFactory eventMessagesFactory, IDocumentRepository documentRepository, IEntityRepository entityRepository, IAuditRepository auditRepository, IContentTypeRepository contentTypeRepository, IDocumentBlueprintRepository documentBlueprintRepository, ILanguageRepository languageRepository, Lazy<IPropertyValidationService> propertyValidationService, IShortStringHelper shortStringHelper, ICultureImpactFactory cultureImpactFactory, IUserIdKeyResolver userIdKeyResolver, PropertyEditorCollection propertyEditorCollection)
Parameters
Type | Name | Description |
---|---|---|
ICoreScopeProvider | provider | |
ILoggerFactory | loggerFactory | |
IEventMessagesFactory | eventMessagesFactory | |
IDocumentRepository | documentRepository | |
IEntityRepository | entityRepository | |
IAuditRepository | auditRepository | |
IContentTypeRepository | contentTypeRepository | |
IDocumentBlueprintRepository | documentBlueprintRepository | |
ILanguageRepository | languageRepository | |
Lazy<IPropertyValidationService> | propertyValidationService | |
IShortStringHelper | shortStringHelper | |
ICultureImpactFactory | cultureImpactFactory | |
IUserIdKeyResolver | userIdKeyResolver | |
PropertyEditorCollection | propertyEditorCollection |
Methods
View SourceCheckDataIntegrity(ContentDataIntegrityReportOptions)
Declaration
public ContentDataIntegrityReport CheckDataIntegrity(ContentDataIntegrityReportOptions options)
Parameters
Type | Name | Description |
---|---|---|
ContentDataIntegrityReportOptions | options |
Returns
Type | Description |
---|---|
ContentDataIntegrityReport |
Copy(IContent, Int32, Boolean, Boolean, Int32)
Copies an IContent object by creating a new Content object of the same type and copies all data from the current to the new copy which is returned.
Declaration
public IContent Copy(IContent content, int parentId, bool relateToOriginal, bool recursive, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | The IContent to copy |
System.Int32 | parentId | Id of the Content's new Parent |
System.Boolean | relateToOriginal | Boolean indicating whether the copy should be related to the original |
System.Boolean | recursive | A value indicating whether to recursively copy children. |
System.Int32 | userId | Optional Id of the User copying the Content |
Returns
Type | Description |
---|---|
IContent | The newly created IContent object |
Copy(IContent, Int32, Boolean, Int32)
Copies an IContent object by creating a new Content object of the same type and copies all data from the current to the new copy which is returned. Recursively copies all children.
Declaration
public IContent Copy(IContent content, int parentId, bool relateToOriginal, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | The IContent to copy |
System.Int32 | parentId | Id of the Content's new Parent |
System.Boolean | relateToOriginal | Boolean indicating whether the copy should be related to the original |
System.Int32 | userId | Optional Id of the User copying the Content |
Returns
Type | Description |
---|---|
IContent | The newly created IContent object |
Count(String)
Declaration
public int Count(string contentTypeAlias = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | contentTypeAlias |
Returns
Type | Description |
---|---|
System.Int32 |
CountChildren(Int32, String)
Declaration
public int CountChildren(int parentId, string contentTypeAlias = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | parentId | |
System.String | contentTypeAlias |
Returns
Type | Description |
---|---|
System.Int32 |
CountDescendants(Int32, String)
Declaration
public int CountDescendants(int parentId, string contentTypeAlias = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | parentId | |
System.String | contentTypeAlias |
Returns
Type | Description |
---|---|
System.Int32 |
CountPublished(String)
Declaration
public int CountPublished(string contentTypeAlias = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | contentTypeAlias |
Returns
Type | Description |
---|---|
System.Int32 |
Create(String, Guid, String, Int32)
Creates an IContent object using the alias of the IContentType that this Content should based on.
Declaration
public IContent Create(string name, Guid parentId, string contentTypeAlias, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the Content object |
Guid | parentId | Id of Parent for the new Content |
System.String | contentTypeAlias | Alias of the IContentType |
System.Int32 | userId | Optional id of the user creating the content |
Returns
Type | Description |
---|---|
IContent | IContent |
Remarks
Note that using this method will simply return a new IContent without any identity as it has not yet been persisted. It is intended as a shortcut to creating new content objects that does not invoke a save operation against the database.
Create(String, Int32, String, Int32)
Creates an IContent object of a specified content type.
Declaration
public IContent Create(string name, int parentId, string contentTypeAlias, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the content object. |
System.Int32 | parentId | The identifier of the parent, or -1. |
System.String | contentTypeAlias | The alias of the content type. |
System.Int32 | userId | The optional id of the user creating the content. |
Returns
Type | Description |
---|---|
IContent | The content object. |
Remarks
This method simply returns a new, non-persisted, IContent without any identity. It is intended as a shortcut to creating new content objects that does not invoke a save operation against the database.
Create(String, Int32, IContentType, Int32)
Creates an IContent object of a specified content type.
Declaration
public IContent Create(string name, int parentId, IContentType contentType, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the content object. |
System.Int32 | parentId | The identifier of the parent, or -1. |
IContentType | contentType | The content type of the content |
System.Int32 | userId | The optional id of the user creating the content. |
Returns
Type | Description |
---|---|
IContent | The content object. |
Remarks
This method simply returns a new, non-persisted, IContent without any identity. It is intended as a shortcut to creating new content objects that does not invoke a save operation against the database.
Create(String, IContent, String, Int32)
Creates an IContent object of a specified content type, under a parent.
Declaration
public IContent Create(string name, IContent parent, string contentTypeAlias, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the content object. |
IContent | parent | The parent content object. |
System.String | contentTypeAlias | The alias of the content type. |
System.Int32 | userId | The optional id of the user creating the content. |
Returns
Type | Description |
---|---|
IContent | The content object. |
Remarks
This method simply returns a new, non-persisted, IContent without any identity. It is intended as a shortcut to creating new content objects that does not invoke a save operation against the database.
CreateAndSave(String, Int32, String, Int32)
Creates an IContent object of a specified content type.
Declaration
public IContent CreateAndSave(string name, int parentId, string contentTypeAlias, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the content object. |
System.Int32 | parentId | The identifier of the parent, or -1. |
System.String | contentTypeAlias | The alias of the content type. |
System.Int32 | userId | The optional id of the user creating the content. |
Returns
Type | Description |
---|---|
IContent | The content object. |
Remarks
This method returns a new, persisted, IContent with an identity.
CreateAndSave(String, IContent, String, Int32)
Creates an IContent object of a specified content type, under a parent.
Declaration
public IContent CreateAndSave(string name, IContent parent, string contentTypeAlias, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the content object. |
IContent | parent | The parent content object. |
System.String | contentTypeAlias | The alias of the content type. |
System.Int32 | userId | The optional id of the user creating the content. |
Returns
Type | Description |
---|---|
IContent | The content object. |
Remarks
This method returns a new, persisted, IContent with an identity.
CreateContentFromBlueprint(IContent, String, Int32)
Declaration
public IContent CreateContentFromBlueprint(IContent blueprint, string name, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | blueprint | |
System.String | name | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
IContent |
Delete(IContent, Int32)
Deletes a document.
Declaration
public OperationResult Delete(IContent content, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
OperationResult |
Remarks
This method will also delete associated media files, child content and possibly associated domains.
This method entirely clears the content from the database.
DeleteBlueprint(IContent, Int32)
Declaration
public void DeleteBlueprint(IContent content, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.Int32 | userId |
DeleteBlueprintsOfType(Int32, Int32)
Declaration
public void DeleteBlueprintsOfType(int contentTypeId, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contentTypeId | |
System.Int32 | userId |
DeleteBlueprintsOfTypes(IEnumerable<Int32>, Int32)
Declaration
public void DeleteBlueprintsOfTypes(IEnumerable<int> contentTypeIds, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<System.Int32> | contentTypeIds | |
System.Int32 | userId |
DeleteOfType(Int32, Int32)
Deletes all content items of specified type. All children of deleted content item is moved to Recycle Bin.
Declaration
public void DeleteOfType(int contentTypeId, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contentTypeId | Id of the IContentType |
System.Int32 | userId | Optional id of the user deleting the media |
Remarks
This needs extra care and attention as its potentially a dangerous and extensive operation
DeleteOfTypes(IEnumerable<Int32>, Int32)
Deletes all content of specified type. All children of deleted content is moved to Recycle Bin.
Declaration
public void DeleteOfTypes(IEnumerable<int> contentTypeIds, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<System.Int32> | contentTypeIds | Id of the IContentType |
System.Int32 | userId | Optional Id of the user issuing the delete operation |
Remarks
This needs extra care and attention as its potentially a dangerous and extensive operation.
Deletes content items of the specified type, and only that type. Does not handle content types inheritance and compositions, which need to be managed outside of this method.
DeleteVersion(Int32, Int32, Boolean, Int32)
Permanently deletes specific version(s) from an IContent object. This method will never delete the latest version of a content item.
Declaration
public void DeleteVersion(int id, int versionId, bool deletePriorVersions, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the IContent object to delete a version from |
System.Int32 | versionId | Id of the version to delete |
System.Boolean | deletePriorVersions | Boolean indicating whether to delete versions prior to the versionId |
System.Int32 | userId | Optional Id of the User deleting versions of a Content object |
DeleteVersions(Int32, DateTime, Int32)
Permanently deletes versions from an IContent object prior to a specific date. This method will never delete the latest version of a content item.
Declaration
public void DeleteVersions(int id, DateTime versionDate, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the IContent object to delete versions from |
DateTime | versionDate | Latest version date |
System.Int32 | userId | Optional Id of the User deleting versions of a Content object |
EmptyRecycleBin(Int32)
Empties the Recycle Bin by deleting all IContent that resides in the bin
Declaration
public OperationResult EmptyRecycleBin(int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | userId |
Returns
Type | Description |
---|---|
OperationResult |
EmptyRecycleBinAsync(Guid)
Declaration
public async Task<OperationResult> EmptyRecycleBinAsync(Guid userId)
Parameters
Type | Name | Description |
---|---|---|
Guid | userId |
Returns
Type | Description |
---|---|
Task<OperationResult> |
GetAncestors(Int32)
Gets a collection of IContent objects, which are ancestors of the current content.
Declaration
public IEnumerable<IContent> GetAncestors(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the IContent to retrieve ancestors for |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
GetAncestors(IContent)
Gets a collection of IContent objects, which are ancestors of the current content.
Declaration
public IEnumerable<IContent> GetAncestors(IContent content)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | IContent to retrieve ancestors for |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
GetBlueprintById(Guid)
Declaration
public IContent GetBlueprintById(Guid id)
Parameters
Type | Name | Description |
---|---|---|
Guid | id |
Returns
Type | Description |
---|---|
IContent |
GetBlueprintById(Int32)
Declaration
public IContent GetBlueprintById(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id |
Returns
Type | Description |
---|---|
IContent |
GetBlueprintsForContentTypes(Int32[])
Declaration
public IEnumerable<IContent> GetBlueprintsForContentTypes(params int[] contentTypeId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | contentTypeId |
Returns
Type | Description |
---|---|
IEnumerable<IContent> |
GetById(Guid)
Gets an IContent object by its 'UniqueId'
Declaration
public IContent GetById(Guid key)
Parameters
Type | Name | Description |
---|---|---|
Guid | key | Guid key of the Content to retrieve |
Returns
Type | Description |
---|---|
IContent | IContent |
GetById(Int32)
Gets an IContent object by Id
Declaration
public IContent GetById(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the Content to retrieve |
Returns
Type | Description |
---|---|
IContent | IContent |
GetByIds(IEnumerable<Guid>)
Gets IContent objects by Ids
Declaration
public IEnumerable<IContent> GetByIds(IEnumerable<Guid> ids)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<Guid> | ids | Ids of the Content to retrieve |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | IContent |
GetByIds(IEnumerable<Int32>)
Gets an IContent object by Id
Declaration
public IEnumerable<IContent> GetByIds(IEnumerable<int> ids)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<System.Int32> | ids | Ids of the Content to retrieve |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | IContent |
GetByLevel(Int32)
Gets a collection of IContent objects by Level
Declaration
public IEnumerable<IContent> GetByLevel(int level)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | level | The level to retrieve Content from |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
Remarks
Contrary to most methods, this method filters out trashed content items.
GetContentForExpiration(DateTime)
Gets documents having an expiration date before (lower than, or equal to) a specified date.
Declaration
public IEnumerable<IContent> GetContentForExpiration(DateTime date)
Parameters
Type | Name | Description |
---|---|---|
DateTime | date |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
Remarks
The content returned from this method may be culture variant, in which case you can use GetStatus(IContent, ContentScheduleCollection, String) to get the status for a specific culture.
GetContentForRelease(DateTime)
Gets documents having a release date before (lower than, or equal to) a specified date.
Declaration
public IEnumerable<IContent> GetContentForRelease(DateTime date)
Parameters
Type | Name | Description |
---|---|---|
DateTime | date |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
Remarks
The content returned from this method may be culture variant, in which case you can use GetStatus(IContent, ContentScheduleCollection, String) to get the status for a specific culture.
GetContentScheduleByContentId(Int32)
Gets publish/unpublish schedule for a content node.
Declaration
public ContentScheduleCollection GetContentScheduleByContentId(int contentId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contentId | Id of the Content to load schedule for |
Returns
Type | Description |
---|---|
ContentScheduleCollection | ContentScheduleCollection |
GetPagedChildren(Int32, Int64, Int32, out Int64, IQuery<IContent>, Ordering)
Gets child documents of a parent.
Declaration
public IEnumerable<IContent> GetPagedChildren(int id, long pageIndex, int pageSize, out long totalChildren, IQuery<IContent> filter = null, Ordering ordering = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | The parent identifier. |
System.Int64 | pageIndex | The page number. |
System.Int32 | pageSize | The page size. |
System.Int64 | totalChildren | |
IQuery<IContent> | filter | Query filter. |
Ordering | ordering | Ordering infos. |
Returns
Type | Description |
---|---|
IEnumerable<IContent> |
GetPagedContentInRecycleBin(Int64, Int32, out Int64, IQuery<IContent>, Ordering)
Gets a collection of an IContent objects, which resides in the Recycle Bin
Declaration
public IEnumerable<IContent> GetPagedContentInRecycleBin(long pageIndex, int pageSize, out long totalRecords, IQuery<IContent> filter = null, Ordering ordering = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | pageIndex | |
System.Int32 | pageSize | |
System.Int64 | totalRecords | |
IQuery<IContent> | filter | |
Ordering | ordering |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
GetPagedDescendants(Int32, Int64, Int32, out Int64, IQuery<IContent>, Ordering)
Gets descendant documents of a given parent.
Declaration
public IEnumerable<IContent> GetPagedDescendants(int id, long pageIndex, int pageSize, out long totalChildren, IQuery<IContent> filter = null, Ordering ordering = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | The parent identifier. |
System.Int64 | pageIndex | The page number. |
System.Int32 | pageSize | The page size. |
System.Int64 | totalChildren | |
IQuery<IContent> | filter | Query filter. |
Ordering | ordering | Ordering infos. |
Returns
Type | Description |
---|---|
IEnumerable<IContent> |
GetPagedOfType(Int32, Int64, Int32, out Int64, IQuery<IContent>, Ordering)
Gets paged documents of a content
Declaration
public IEnumerable<IContent> GetPagedOfType(int contentTypeId, long pageIndex, int pageSize, out long totalRecords, IQuery<IContent> filter = null, Ordering ordering = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contentTypeId | The page number. |
System.Int64 | pageIndex | The page number. |
System.Int32 | pageSize | The page size. |
System.Int64 | totalRecords | Total number of documents. |
IQuery<IContent> | filter | Search text filter. |
Ordering | ordering | Ordering infos. |
Returns
Type | Description |
---|---|
IEnumerable<IContent> |
GetPagedOfTypes(Int32[], Int64, Int32, out Int64, IQuery<IContent>, Ordering)
Gets paged documents for specified content types
Declaration
public IEnumerable<IContent> GetPagedOfTypes(int[] contentTypeIds, long pageIndex, int pageSize, out long totalRecords, IQuery<IContent> filter, Ordering ordering = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32[] | contentTypeIds | The page number. |
System.Int64 | pageIndex | The page number. |
System.Int32 | pageSize | The page size. |
System.Int64 | totalRecords | Total number of documents. |
IQuery<IContent> | filter | Search text filter. |
Ordering | ordering | Ordering infos. |
Returns
Type | Description |
---|---|
IEnumerable<IContent> |
GetParent(Int32)
Gets the parent of the current content as an IContent item.
Declaration
public IContent GetParent(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the IContent to retrieve the parent from |
Returns
Type | Description |
---|---|
IContent | Parent IContent object |
GetParent(IContent)
Gets the parent of the current content as an IContent item.
Declaration
public IContent GetParent(IContent content)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | IContent to retrieve the parent from |
Returns
Type | Description |
---|---|
IContent | Parent IContent object |
GetPermissions(IContent)
Returns implicit/inherited permissions assigned to the content item for all user groups
Declaration
public EntityPermissionCollection GetPermissions(IContent content)
Parameters
Type | Name | Description |
---|---|---|
IContent | content |
Returns
Type | Description |
---|---|
EntityPermissionCollection |
GetPublishedChildren(Int32)
Gets a collection of published IContent objects by Parent Id
Declaration
public IEnumerable<IContent> GetPublishedChildren(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the Parent to retrieve Children from |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of published IContent objects |
GetRootContent()
Gets a collection of IContent objects, which reside at the first level / root
Declaration
public IEnumerable<IContent> GetRootContent()
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
GetVersion(Int32)
Gets a specific version of an IContent item.
Declaration
public IContent GetVersion(int versionId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | versionId | Id of the version to retrieve |
Returns
Type | Description |
---|---|
IContent | An IContent item |
GetVersionIds(Int32, Int32)
Gets a list of all version Ids for the given content item ordered so latest is first
Declaration
public IEnumerable<int> GetVersionIds(int id, int maxRows)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | |
System.Int32 | maxRows | The maximum number of rows to return |
Returns
Type | Description |
---|---|
IEnumerable<System.Int32> |
GetVersions(Int32)
Gets a collection of an IContent objects versions by Id
Declaration
public IEnumerable<IContent> GetVersions(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
GetVersionsSlim(Int32, Int32, Int32)
Gets a collection of an IContent objects versions by Id
Declaration
public IEnumerable<IContent> GetVersionsSlim(int id, int skip, int take)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | |
System.Int32 | skip | |
System.Int32 | take |
Returns
Type | Description |
---|---|
IEnumerable<IContent> | An Enumerable list of IContent objects |
HasChildren(Int32)
Checks whether an IContent item has any children
Declaration
public bool HasChildren(int id)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Id of the IContent |
Returns
Type | Description |
---|---|
System.Boolean | True if the content has any children otherwise False |
IsPathPublishable(IContent)
Checks if the passed in IContent can be published based on the ancestors publish state.
Declaration
public bool IsPathPublishable(IContent content)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | IContent to check if ancestors are published |
Returns
Type | Description |
---|---|
System.Boolean | True if the Content can be published, otherwise False |
IsPathPublished(IContent)
Declaration
public bool IsPathPublished(IContent content)
Parameters
Type | Name | Description |
---|---|---|
IContent | content |
Returns
Type | Description |
---|---|
System.Boolean |
Move(IContent, Int32, Int32)
Moves an IContent object to a new location by changing its parent id.
Declaration
public OperationResult Move(IContent content, int parentId, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | The IContent to move |
System.Int32 | parentId | Id of the Content's new Parent |
System.Int32 | userId | Optional Id of the User moving the Content |
Returns
Type | Description |
---|---|
OperationResult |
Remarks
If the IContent object is already published it will be published after being moved to its new location. Otherwise it'll just be saved with a new parent id.
MoveToRecycleBin(IContent, Int32)
Moves a document to the recycle bin.
Declaration
public OperationResult MoveToRecycleBin(IContent content, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
OperationResult |
PerformScheduledPublish(DateTime)
Publishes and unpublishes scheduled documents.
Declaration
public IEnumerable<PublishResult> PerformScheduledPublish(DateTime date)
Parameters
Type | Name | Description |
---|---|---|
DateTime | date |
Returns
Type | Description |
---|---|
IEnumerable<PublishResult> |
PersistContentSchedule(IContent, ContentScheduleCollection)
Persists publish/unpublish schedule for a content node.
Declaration
public void PersistContentSchedule(IContent content, ContentScheduleCollection contentSchedule)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
ContentScheduleCollection | contentSchedule |
Publish(IContent, String[], Int32)
Declaration
public PublishResult Publish(IContent content, string[] cultures, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.String[] | cultures | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
PublishResult |
PublishBranch(IContent, Boolean, String[], Int32)
Publishes a document branch.
Declaration
public IEnumerable<PublishResult> PublishBranch(IContent content, bool force, string[] cultures, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | The root document. |
System.Boolean | force | A value indicating whether to force-publish documents that are not already published. |
System.String[] | cultures | The cultures to publish. |
System.Int32 | userId | The identifier of the user performing the operation. |
Returns
Type | Description |
---|---|
IEnumerable<PublishResult> |
Remarks
The force
parameter determines which documents are published. When false
,
only those documents that are already published, are republished. When true
, all documents are
published. The root of the branch is always published, regardless of force
.
RecycleBinSmells()
Declaration
public bool RecycleBinSmells()
Returns
Type | Description |
---|---|
System.Boolean |
Rollback(Int32, Int32, String, Int32)
Declaration
public OperationResult Rollback(int id, int versionId, string culture = "*", int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | |
System.Int32 | versionId | |
System.String | culture | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
OperationResult |
Save(IEnumerable<IContent>, Int32)
Saves documents.
Declaration
public OperationResult Save(IEnumerable<IContent> contents, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<IContent> | contents | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
OperationResult |
Save(IContent, Nullable<Int32>, ContentScheduleCollection)
Saves a document.
Declaration
public OperationResult Save(IContent content, int? userId = null, ContentScheduleCollection contentSchedule = null)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.Nullable<System.Int32> | userId | |
ContentScheduleCollection | contentSchedule |
Returns
Type | Description |
---|---|
OperationResult |
SaveAndPublish(IContent, String, Int32)
Declaration
public PublishResult SaveAndPublish(IContent content, string culture = "*", int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.String | culture | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
PublishResult |
SaveAndPublish(IContent, String[], Int32)
Declaration
public PublishResult SaveAndPublish(IContent content, string[] cultures, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.String[] | cultures | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
PublishResult |
SaveAndPublishBranch(IContent, Boolean, String, Int32)
Declaration
public IEnumerable<PublishResult> SaveAndPublishBranch(IContent content, bool force, string culture = "*", int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.Boolean | force | |
System.String | culture | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
IEnumerable<PublishResult> |
SaveAndPublishBranch(IContent, Boolean, String[], Int32)
Declaration
public IEnumerable<PublishResult> SaveAndPublishBranch(IContent content, bool force, string[] cultures, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.Boolean | force | |
System.String[] | cultures | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
IEnumerable<PublishResult> |
SaveBlueprint(IContent, Int32)
Declaration
public void SaveBlueprint(IContent content, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.Int32 | userId |
SendToPublication(IContent, Int32)
Sends an IContent to Publication, which executes handlers and events for the 'Send to Publication' action.
Declaration
public bool SendToPublication(IContent content, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | The IContent to send to publication |
System.Int32 | userId | Optional Id of the User issuing the send to publication |
Returns
Type | Description |
---|---|
System.Boolean | True if sending publication was successful otherwise false |
SetPermission(IContent, String, IEnumerable<Int32>)
Assigns a single permission to the current content item for the specified group ids
Declaration
public void SetPermission(IContent entity, string permission, IEnumerable<int> groupIds)
Parameters
Type | Name | Description |
---|---|---|
IContent | entity | |
System.String | permission | |
IEnumerable<System.Int32> | groupIds |
SetPermissions(EntityPermissionSet)
Used to bulk update the permissions set for a content item. This will replace all permissions assigned to an entity with a list of user id & permission pairs.
Declaration
public void SetPermissions(EntityPermissionSet permissionSet)
Parameters
Type | Name | Description |
---|---|---|
EntityPermissionSet | permissionSet |
Sort(IEnumerable<IContent>, Int32)
Sorts a collection of IContent objects by updating the SortOrder according
to the ordering of items in the passed in items
.
Declaration
public OperationResult Sort(IEnumerable<IContent> items, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<IContent> | items | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
OperationResult | Result indicating what action was taken when handling the command. |
Remarks
Using this method will ensure that the Published-state is maintained upon sorting so the cache is updated accordingly - as needed.
Sort(Nullable<IEnumerable<Int32>>, Int32)
Sorts a collection of IContent objects by updating the SortOrder according
to the ordering of items identified by the ids
.
Declaration
public OperationResult Sort(IEnumerable<int>? ids, int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<IEnumerable<System.Int32>> | ids | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
OperationResult | Result indicating what action was taken when handling the command. |
Remarks
Using this method will ensure that the Published-state is maintained upon sorting so the cache is updated accordingly - as needed.
Unpublish(IContent, String, Int32)
Unpublishes a document.
Declaration
public PublishResult Unpublish(IContent content, string culture = "*", int userId = -1)
Parameters
Type | Name | Description |
---|---|---|
IContent | content | |
System.String | culture | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
PublishResult |
Remarks
By default, unpublishes the document as a whole, but it is possible to specify a culture to be unpublished. Depending on whether that culture is mandatory, and other cultures remain published, the document as a whole may or may not remain published.
If the content type is variant, then culture can be either '' or an actual culture, but neither null nor empty. If the content type is invariant, then culture can be either '' or null or empty.
Explicit Interface Implementations
View SourceIContentServiceBase<IContent>.Save(IEnumerable<IContent>, Int32)
Declaration
Attempt<OperationResult> IContentServiceBase<IContent>.Save(IEnumerable<IContent> contents, int userId)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<IContent> | contents | |
System.Int32 | userId |
Returns
Type | Description |
---|---|
Attempt<OperationResult> |