Interface IContentItemManager

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Provides management API for typical content item operations.

public interface IContentItemManager

Extension Methods

ContentItemManagerSchedulingExtensions.CancelScheduledPublish(IContentItemManager, int, string, CancellationToken)

ContentItemManagerSchedulingExtensions.CancelScheduledUnpublish(IContentItemManager, int, string, CancellationToken)

ContentItemManagerSchedulingExtensions.IsPublishScheduled(IContentItemManager, int, string, CancellationToken)

ContentItemManagerSchedulingExtensions.IsUnpublishScheduled(IContentItemManager, int, string, CancellationToken)

ContentItemManagerSchedulingExtensions.SchedulePublish(IContentItemManager, int, string, DateTime, CancellationToken)

ContentItemManagerSchedulingExtensions.ScheduleUnpublish(IContentItemManager, int, string, DateTime, CancellationToken)

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

The interface does not support custom implementation.

Methods

CancelScheduledPublish(int, string, CancellationToken)

Cancels scheduled publish of the content item.

Task CancelScheduledPublish(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Content item identifier.

languageName string

Language codename.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

Remarks

The method also cancels scheduled unpublish if it was set.

CancelScheduledUnpublish(int, string, CancellationToken)

Cancels scheduled unpublish of the content item.

Task CancelScheduledUnpublish(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Content item identifier.

languageName string

Language codename.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

Create(CreateContentItemParameters, ContentItemData, CancellationToken)

Creates a new content item as specified by the itemParameters and itemData.

Task<int> Create(CreateContentItemParameters itemParameters, ContentItemData itemData, CancellationToken cancellationToken = default)

Parameters

itemParameters CreateContentItemParameters

Parameters to be set for newly created content item.

itemData ContentItemData

Initial content item data.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<int>

ID of newly created content item.

Exceptions

ArgumentNullException

Thrown when itemParameters or itemData is null.

ArgumentException

Thrown when content type for ContentTypeName is not found or is not reusable one.

InvalidOperationException

Thrown when no content language with the code name specified in LanguageName exist. Thrown when ScheduledPublishWhen is set and VersionStatus is not InitialDraft. Thrown when ScheduledUnpublishWhen is set without ScheduledPublishWhen and VersionStatus is not Published. Thrown when ScheduledUnpublishWhen is before ScheduledPublishWhen.

Delete(int, string, CancellationToken)

Deletes content item data for a specific language variant. If this is the last content item variant, the parent content item is removed as well.

Task Delete(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item language variant.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

Exceptions

ArgumentException

Thrown when the languageName is null or empty or when contentItemId does not identify a reusable item.

GetContentItemLanguageMetadata(int, string, CancellationToken)

Retrieves language specific ContentItemLanguageMetadata of the latest version of a content item identified by contentItemId and languageName.

Task<ContentItemLanguageMetadata> GetContentItemLanguageMetadata(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ContentItemLanguageMetadata>

Remarks

To update content item language metadata, use the manager class responsible for the corresponding content type type (reusable, webpage, headless, etc.).

Exceptions

ArgumentException

Thrown when the languageName is null or empty.

InvalidOperationException

Thrown when no content item identified by contentItemId and languageName exists.

GetContentItemMetadata(int, CancellationToken)

Retrieves ContentItemMetadata of a content item identified by contentItemId.

Task<ContentItemMetadata> GetContentItemMetadata(int contentItemId, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ContentItemMetadata>

Remarks

To update content item metadata, use the manager class responsible for the corresponding content type type (reusable, webpage, headless, etc.).

Exceptions

ArgumentException

Thrown when content type for contentItemId is not found.

ContentItemNotFoundException

Thrown when no content item identified by contentItemId exists.

SchedulePublish(int, string, DateTime, CancellationToken)

Schedules publish of the content item.

Task SchedulePublish(int contentItemId, string languageName, DateTime scheduledTime, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Content item identifier.

languageName string

Language codename.

scheduledTime DateTime

Date and time when the content item should be published.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

ScheduleUnpublish(int, string, DateTime, CancellationToken)

Schedules unpublish of the content item.

Task ScheduleUnpublish(int contentItemId, string languageName, DateTime scheduledTime, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Content item identifier.

languageName string

Language codename.

scheduledTime DateTime

Date and time when the content item should be unpublished.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

TryArchive(int, string, CancellationToken)

Attempts to archive a content item with Published status for a specific language variant.

[Obsolete("Archive status was replaced by Unpublished status, use TryUnpublish instead.")]
[ObsoleteSince(29, 2)]
Task<bool> TryArchive(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item language variant.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the content item was successfully archived or false if there is no Published version available for the item.

Exceptions

ArgumentException

Thrown when the languageName is null or empty or when contentItemId does not identify a reusable item.

ContentItemNotFoundException

Thrown when no content item identified by contentItemId and languageName exists.

InvalidOperationException

Thrown when there is an unexpected error in the item data structure.

TryCreateDraft(int, string, CancellationToken)

Attempts to create a new content item with Draft status from content item with Published or Unpublished status for a specific language variant.

Task<bool> TryCreateDraft(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item language variant.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the draft of content item was successfully created or false if there is no Published or Unpublished version available for the item.

Exceptions

ArgumentException

Thrown when the languageName is null or empty or when contentItemId does not identify a reusable item.

ContentItemNotFoundException

Thrown when no content item identified by contentItemId and languageName exists.

InvalidOperationException

Thrown when there is an unexpected error in the item data structure.

TryCreateLanguageVariant(CreateLanguageVariantParameters, ContentItemData, CancellationToken)

Tries to create a new language variant of an existing content item, specified by the language codename provided in CreateLanguageVariantParameters.

Task<bool> TryCreateLanguageVariant(CreateLanguageVariantParameters parameters, ContentItemData contentItemData, CancellationToken cancellationToken = default)

Parameters

parameters CreateLanguageVariantParameters

Parameters for the creation of a new language variant.

contentItemData ContentItemData

Content item data of the content item.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if a new language variant of the content item was created, false if the content item already exists in the target language specified by LanguageName.

Exceptions

ArgumentException

Thrown when ContentItemId does not identify a reusable item.

ArgumentNullException

Thrown if either of parameters or contentItemData is null.

ContentItemNotFoundException

Thrown when no content item with the ContentItemId specified in CreateLanguageVariantParameters exists.

InvalidOperationException

Thrown when no content language with the code name specified in LanguageName exist. Thrown when ScheduledPublishWhen is set and VersionStatus is not InitialDraft. Thrown when ScheduledUnpublishWhen is set without ScheduledPublishWhen and VersionStatus is not Published. Thrown when ScheduledUnpublishWhen is before ScheduledPublishWhen.

TryDiscardDraft(int, string, CancellationToken)

Attempts to discard content item with Draft status for a specific language variant.

Task<bool> TryDiscardDraft(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item language variant.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the draft of content item was successfully discarded or false if there is no Draft and also one Unpublished or Published version available for the item.

Exceptions

ArgumentException

Thrown when the languageName is null or empty or when contentItemId does not identify a reusable item.

ContentItemNotFoundException

Thrown when no content item identified by contentItemId and languageName exists.

InvalidOperationException

Thrown when there is an unexpected error in the item data structure.

TryPublish(int, string, CancellationToken)

Attempts to publish a content item that is in Draft or InitialDraft status for a specific language variant.

Task<bool> TryPublish(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item language variant.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the content item was successfully published or false if there is no InitialDraft or Draft version available for the item.

Exceptions

ArgumentException

Thrown when the languageName is null or empty or when contentItemId does not identify a reusable item.

ContentItemNotFoundException

Thrown when no content item identified by contentItemId and languageName exists.

InvalidOperationException

Thrown when there is an unexpected error in the item data structure.

TryUnpublish(int, string, CancellationToken)

Attempts to unpublish a content item with Published status for a specific language variant.

Task<bool> TryUnpublish(int contentItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item language variant.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the content item was successfully unpublished or false if there is no Published version available for the item.

Exceptions

ArgumentException

Thrown when the languageName is null or empty or when contentItemId does not identify a reusable item.

ContentItemNotFoundException

Thrown when no content item identified by contentItemId and languageName exists.

InvalidOperationException

Thrown when there is an unexpected error in the item data structure.

TryUpdateDraft(int, string, ContentItemData, CancellationToken)

Attempts to update content item data in Draft or InitialDraft status for a specific language variant.

Task<bool> TryUpdateDraft(int contentItemId, string languageName, ContentItemData itemData, CancellationToken cancellationToken = default)

Parameters

contentItemId int

Id of the content item.

languageName string

Language codename of the content item language variant.

itemData ContentItemData

Updated content item data.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

True if the content item was successfully updated or false if there is no Draft or InitialDraft version available for the item.

Exceptions

ArgumentNullException

Thrown when itemData is null.

ArgumentException

Thrown when the languageName is null or empty or when contentItemId does not identify a reusable item.

ContentItemNotFoundException

Thrown when no content item identified by contentItemId and languageName exists.

InvalidOperationException

Thrown when there is an unexpected error in the item data structure.

UpdateLanguageMetadata(ContentItemLanguageMetadata, CancellationToken)

Updates the content item language data, allowing a new value to be set in the ContentItemLanguageMetadata object.

Task UpdateLanguageMetadata(ContentItemLanguageMetadata contentItemLanguageMetadata, CancellationToken cancellationToken = default)

Parameters

contentItemLanguageMetadata ContentItemLanguageMetadata

Content item language metadata with updated values.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

Exceptions

ArgumentException

Thrown when ContentItemID is not found or does not identify a reusable item.

ArgumentNullException

Thrown if contentItemLanguageMetadata is null.

InvalidOperationException

Thrown when no content item with the identifier specified in ContentItemID and LanguageName exists. Thrown when ScheduledPublishWhen is set and LatestVersionStatus is not InitialDraft or Draft. Thrown when ScheduledUnpublishWhen is set without ScheduledPublishWhen and LatestVersionStatus is not Published. Thrown when ScheduledUnpublishWhen is before ScheduledPublishWhen.

UpdateMetadata(ContentItemMetadata, CancellationToken)

Updates the content item data, allowing a new value to be set in the ContentItemMetadata object.

Task UpdateMetadata(ContentItemMetadata contentItemMetadata, CancellationToken cancellationToken = default)

Parameters

contentItemMetadata ContentItemMetadata

Content item metadata with updated values.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

Exceptions

ArgumentException

Thrown when content type ContentTypeID is not found or is not reusable one.

ArgumentNullException

Thrown if contentItemMetadata is null.

ContentItemNotFoundException

Thrown when no content item with the identifier specified in ContentItemID exists.

CodeNameNotValidException

Thrown when Name is not in valid format. The code name can contain only alphanumeric characters, some special characters (_, -, .) and cannot start or end with '.'.

CodeNameNotUniqueException

Thrown when Name is not globally unique code name.