Table of Contents

Class ContentHubList

Namespace
Kentico.Xperience.Admin.Base.UIPages
Assembly
Kentico.Xperience.Admin.Base.dll

Content hub listing page.

public sealed class ContentHubList : ListingPage<ContentHubListClientProperties>, IPage
Inheritance
object
ContentHubList
Implements
Inherited Members
Extension Methods

Constructors

ContentHubList(IContentItemManagerFactory, IAuthenticatedUserAccessor, IInfoProvider<ContentItemLanguageMetadataInfo>, IFormComponentCommandInvoker, IContentItemsAdminPublisher, IPublishabilityCheckTableRetriever, ICascadePublishTableRetriever, IContentHubActionsTableClientPropertiesConfigurator, IFormDataBinder, IInfoProvider<SmartFolderInfo>, IInfoProvider<ContentItemReferenceInfo>, IInfoProvider<ContentLanguageInfo>)

Retrieves a folder based on the provided request.

public ContentHubList(IContentItemManagerFactory contentItemManagerFactory, IAuthenticatedUserAccessor userAccessor, IInfoProvider<ContentItemLanguageMetadataInfo> contentItemLanguageMetadataInfoProvider, IFormComponentCommandInvoker formComponentCommandInvoker, IContentItemsAdminPublisher contentItemsAdminPublisher, IPublishabilityCheckTableRetriever publishabilityCheckTableRetriever, ICascadePublishTableRetriever cascadePublishTableRetriever, IContentHubActionsTableClientPropertiesConfigurator contentHubActionsTableClientPropertiesConfigurator, IFormDataBinder formDataBinder, IInfoProvider<SmartFolderInfo> smartFoldersProvider, IInfoProvider<ContentItemReferenceInfo> contentItemReferenceInfoProvider, IInfoProvider<ContentLanguageInfo> contentLanguageInfoProvider)

Parameters

contentItemManagerFactory IContentItemManagerFactory
userAccessor IAuthenticatedUserAccessor
contentItemLanguageMetadataInfoProvider IInfoProvider<ContentItemLanguageMetadataInfo>
formComponentCommandInvoker IFormComponentCommandInvoker
contentItemsAdminPublisher IContentItemsAdminPublisher
publishabilityCheckTableRetriever IPublishabilityCheckTableRetriever
cascadePublishTableRetriever ICascadePublishTableRetriever
contentHubActionsTableClientPropertiesConfigurator IContentHubActionsTableClientPropertiesConfigurator
formDataBinder IFormDataBinder
smartFoldersProvider IInfoProvider<SmartFolderInfo>
contentItemReferenceInfoProvider IInfoProvider<ContentItemReferenceInfo>
contentLanguageInfoProvider IInfoProvider<ContentLanguageInfo>

Properties

ContentLanguageIdentifier

Page parameters.

[PageParameter(typeof(ContentLanguageModelBinder), typeof(ContentHubContentLanguage))]
public ContentLanguageUrlIdentifier ContentLanguageIdentifier { get; set; }

Property Value

ContentLanguageUrlIdentifier

FolderId

Folder identifier.

[PageParameter(typeof(ContentFolderModelBinder), typeof(ContentHubFolder))]
public ContentFolderId FolderId { get; set; }

Property Value

ContentFolderId

IdColumn

Name of the column which is as an identifier of the listed objects.

protected override string IdColumn { get; }

Property Value

string

ObjectType

Type of the info objects that are listed. Corresponds to the OBJECT_TYPE property of the info object or PredefinedObjectType.

protected override string ObjectType { get; }

Property Value

string

WorkspaceIdentifier

Workspace parameters.

[PageParameter(typeof(WorkspaceModelBinder), typeof(ContentHubWorkspace))]
public WorkspaceUrlIdentifier WorkspaceIdentifier { get; set; }

Property Value

WorkspaceUrlIdentifier

Methods

ChangeCreateSmartFolderForm(FormSubmissionCommandArguments, CancellationToken)

Handles the create smart folder form change command. The command is invoked whenever visibility conditions or form component configurators of the form need to be reevaluated to re-render the form.

public Task<ICommandResponse<FilterFormChangeResult>> ChangeCreateSmartFolderForm(FormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormSubmissionCommandArguments

Form change arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<FilterFormChangeResult>>

CloneSmartFolder(CloneSmartFolderArguments, CancellationToken)

public Task<ICommandResponse<CloneSmartFolderResult>> CloneSmartFolder(CloneSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args CloneSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<CloneSmartFolderResult>>

CompleteUpload(CompleteMassAssetUploadCommandArguments, CancellationToken)

Completes the upload of the file.

public Task<ICommandResponse<CompleteMassAssetUploadCommandResult>> CompleteUpload(CompleteMassAssetUploadCommandArguments args, CancellationToken cancellationToken)

Parameters

args CompleteMassAssetUploadCommandArguments

Complete upload command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<CompleteMassAssetUploadCommandResult>>

ComponentCommand(FormComponentCommandModel, CancellationToken)

Handles the form component command invocation.

public override Task<object> ComponentCommand(FormComponentCommandModel commandModel, CancellationToken cancellationToken)

Parameters

commandModel FormComponentCommandModel

Form component command arguments.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<object>

Returns the form component command result.

ConfigurePage()

Allows configure and share page specific values prior invocation of the ConfigureTemplateProperties(TClientProperties) or command method.

public override Task ConfigurePage()

Returns

Task

ConfigureTemplateProperties(ContentHubListClientProperties)

Gets the object representing client side template properties.

public override Task<ContentHubListClientProperties> ConfigureTemplateProperties(ContentHubListClientProperties properties)

Parameters

properties ContentHubListClientProperties

Initialized properties object.

Returns

Task<ContentHubListClientProperties>

CreateFolder(CreateFolderArguments, CancellationToken)

public Task<ICommandResponse<CreateFolderResult>> CreateFolder(CreateFolderArguments args, CancellationToken cancellationToken)

Parameters

args CreateFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateFolderResult>>

CreateSmartFolder(CreateSmartFolderArguments, CancellationToken)

public Task<ICommandResponse<CreateSmartFolderResult>> CreateSmartFolder(CreateSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args CreateSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateSmartFolderResult>>

CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken)

public Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>> CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments args, CancellationToken cancellationToken)

Parameters

args CreateSmartFolderConfirmFilterArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>>

Delete(int)

Deletes listing item specified by the id parameter.

public override Task<ICommandResponse<RowActionResult>> Delete(int id)

Parameters

id int

Returns

Task<ICommandResponse<RowActionResult>>

DeleteFolder(DeleteFolderArguments, CancellationToken)

public Task<ICommandResponse<DeleteFolderResult>> DeleteFolder(DeleteFolderArguments args, CancellationToken cancellationToken)

Parameters

args DeleteFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<DeleteFolderResult>>

DeleteSmartFolder(DeleteSmartFolderArguments, CancellationToken)

public Task<ICommandResponse> DeleteSmartFolder(DeleteSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args DeleteSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse>

DoesFilterSupportDelivery(FilterDeliverySupportArguments, CancellationToken)

public Task<ICommandResponse<FilterDeliverySupportResult>> DoesFilterSupportDelivery(FilterDeliverySupportArguments args, CancellationToken cancellationToken = default)

Parameters

args FilterDeliverySupportArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<FilterDeliverySupportResult>>

EnableContentDeliveryForSmartFolder(EnableContentDeliveryForSmartFolderArguments, CancellationToken)

public Task<ICommandResponse> EnableContentDeliveryForSmartFolder(EnableContentDeliveryForSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args EnableContentDeliveryForSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse>

GetFilterFormComponentsContext()

Gets the form component context for the form components.

protected override Task<IFormContext> GetFilterFormComponentsContext()

Returns

Task<IFormContext>

GetFolder(GetFolderArguments, CancellationToken)

Routes the command to the GetFolder(GetFolderArguments, CancellationToken) method.

public Task<ICommandResponse<Folder>> GetFolder(GetFolderArguments args, CancellationToken cancellationToken)

Parameters

args GetFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<Folder>>

GetFolderPath(GetFolderArguments, CancellationToken)

Routes the command to the GetFolderPath(GetFolderArguments, CancellationToken) method.

public Task<ICommandResponse<ICollection<Folder>>> GetFolderPath(GetFolderArguments args, CancellationToken cancellationToken)

Parameters

args GetFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<ICollection<Folder>>>

GetFolderSubtree(GetFolderArguments, CancellationToken)

public Task<ICommandResponse<Folder>> GetFolderSubtree(GetFolderArguments args, CancellationToken cancellationToken)

Parameters

args GetFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<Folder>>

GetFormItemsForCloneSmartFolder(GetFormItemsArguments, CancellationToken)

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForCloneSmartFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForCreateFolder(GetFormItemsArguments, CancellationToken)

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForCreateFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForCreateSmartFolder(CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.ISmartFolderCommandManager.GetFormItemsForCreateSmartFolder(System.Threading.CancellationToken) method.

public Task<ICommandResponse<GetFormItemsForCreateSmartFolderResult>> GetFormItemsForCreateSmartFolder(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsForCreateSmartFolderResult>>

GetFormItemsForFolderProperties(GetFormItemsArguments, CancellationToken)

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForFolderProperties(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForMoveFolder(GetFormItemsArguments, CancellationToken)

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForMoveFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForRenameFolder(GetFormItemsArguments, CancellationToken)

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForRenameFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForRenameSmartFolder(GetFormItemsArguments, CancellationToken)

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForRenameSmartFolder(GetFormItemsArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForSaveSmartFolder(CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.ISmartFolderCommandManager.GetFormItemsForSaveSmartFolder(System.Threading.CancellationToken) method.

public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForSaveSmartFolder(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsResult>>

GetFormItemsForSmartFolderProperties(GetFormItemsForSmartFolderPropertiesArguments, CancellationToken)

public Task<ICommandResponse<GetFormItemsForSmartFolderPropertiesResult>> GetFormItemsForSmartFolderProperties(GetFormItemsForSmartFolderPropertiesArguments args, CancellationToken cancellationToken)

Parameters

args GetFormItemsForSmartFolderPropertiesArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetFormItemsForSmartFolderPropertiesResult>>

GetSmartFolderFilter(GetSmartFolderFilterArguments, CancellationToken)

public Task<ICommandResponse<GetSmartFolderFilterResult>> GetSmartFolderFilter(GetSmartFolderFilterArguments args, CancellationToken cancellationToken)

Parameters

args GetSmartFolderFilterArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSmartFolderFilterResult>>

GetSmartFolders(CancellationToken)

public Task<ICommandResponse<GetSmartFoldersResult>> GetSmartFolders(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSmartFoldersResult>>

IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments, CancellationToken)

public Task<ICommandResponse<SmartFolderDeliverySupportResult>> IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments args, CancellationToken cancellationToken = default)

Parameters

args SmartFolderDeliverySupportArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<SmartFolderDeliverySupportResult>>

LoadData(LoadDataSettings, CancellationToken)

Returns LoadDataResult containing data and the number of total items.

protected override Task<LoadDataResult> LoadData(LoadDataSettings settings, CancellationToken cancellationToken)

Parameters

settings LoadDataSettings

Load data settings.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<LoadDataResult>

LoadDeleteTableItems(LoadDeleteTableItemsCommandArguments, CancellationToken)

Checks if content items are in use and returns rows of items in use.

public Task<ICommandResponse<LoadDataResult>> LoadDeleteTableItems(LoadDeleteTableItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadDeleteTableItemsCommandArguments

Load data command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadDataResult>>

MassDelete(IEnumerable<int>, CancellationToken)

Deletes content items specified by the identifiers parameter.

public Task<ICommandResponse<MassActionResult>> MassDelete(IEnumerable<int> identifiers, CancellationToken cancellationToken)

Parameters

identifiers IEnumerable<int>
cancellationToken CancellationToken

Returns

Task<ICommandResponse<MassActionResult>>

MassMove(IEnumerable<int>, MoveContentItemModel, CancellationToken)

Moves multiple content items to a folder specified by the model.

public Task<ICommandResponse<MassActionResult>> MassMove(IEnumerable<int> identifiers, MoveContentItemModel model, CancellationToken cancellationToken)

Parameters

identifiers IEnumerable<int>

Ids of the content items to be moved.

model MoveContentItemModel

Model describing where to move the content items.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<MassActionResult>>

MassPublish(IEnumerable<ContentItemIdentifier>, CancellationToken)

Publishes content items specified by the contentItemIdentifiers parameter.

public Task<ICommandResponse<MassActionResult>> MassPublish(IEnumerable<ContentItemIdentifier> contentItemIdentifiers, CancellationToken cancellationToken)

Parameters

contentItemIdentifiers IEnumerable<ContentItemIdentifier>
cancellationToken CancellationToken

Returns

Task<ICommandResponse<MassActionResult>>

MassPublishLoadCascadePublishTableItems(LoadCascadePublishTableItemsCommandArguments, CancellationToken)

Loads available content items.

public Task<ICommandResponse<LoadDataResult>> MassPublishLoadCascadePublishTableItems(LoadCascadePublishTableItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadCascadePublishTableItemsCommandArguments

Load data command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadDataResult>>

MoveContentItem(int, MoveContentItemModel, CancellationToken)

Moves a content item to a folder specified by the model.

public Task<ICommandResponse<RowActionResult>> MoveContentItem(int id, MoveContentItemModel model, CancellationToken cancellationToken)

Parameters

id int

Id of the content item to be moved.

model MoveContentItemModel

Model describing where to move the content item.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<RowActionResult>>

MoveFolder(MoveFolderArguments, CancellationToken)

public Task<ICommandResponse<MoveFolderResult>> MoveFolder(MoveFolderArguments args, CancellationToken cancellationToken)

Parameters

args MoveFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<MoveFolderResult>>

MoveItemFormChange(FormChangeCommandArguments, CancellationToken)

Handles the change command for confirmation dialog. The command is invoked whenever visibility conditions or form component configurators of the form need to be reevaluated to re-render the form.

public Task<ICommandResponse<FormChangeResult>> MoveItemFormChange(FormChangeCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormChangeCommandArguments

Form change command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<FormChangeResult>>

PublishabilityCheck(IEnumerable<int>, CancellationToken)

Checks which of selected content items specified by the identifiers parameter can be published and returns a message result.

public Task<ICommandResponse<PublishabilityCheckResult>> PublishabilityCheck(IEnumerable<int> identifiers, CancellationToken cancellationToken)

Parameters

identifiers IEnumerable<int>
cancellationToken CancellationToken

Returns

Task<ICommandResponse<PublishabilityCheckResult>>

PublishabilityCheckLoadUnpublishableItems(PublishabilityCheckLoadItemsCommandArguments, CancellationToken)

Checks which of selected content items cannot be published and returns rows of non publishable items.

public Task<ICommandResponse<LoadDataResult>> PublishabilityCheckLoadUnpublishableItems(PublishabilityCheckLoadItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args PublishabilityCheckLoadItemsCommandArguments

Load data command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadDataResult>>

RenameFolder(RenameFolderArguments, CancellationToken)

public Task<ICommandResponse<RenameFolderResult>> RenameFolder(RenameFolderArguments args, CancellationToken cancellationToken)

Parameters

args RenameFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<RenameFolderResult>>

RenameSmartFolder(RenameSmartFolderArguments, CancellationToken)

public Task<ICommandResponse<RenameFolderResult>> RenameSmartFolder(RenameSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args RenameSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<RenameFolderResult>>

SaveSmartFolder(SaveSmartFolderArguments, CancellationToken)

public Task<ICommandResponse<SaveSmartFolderResult>> SaveSmartFolder(SaveSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args SaveSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<SaveSmartFolderResult>>

UpdateFolderProperties(UpdateFolderPropertiesArguments, CancellationToken)

public Task<ICommandResponse<UpdateFolderPropertiesResult>> UpdateFolderProperties(UpdateFolderPropertiesArguments args, CancellationToken cancellationToken)

Parameters

args UpdateFolderPropertiesArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<UpdateFolderPropertiesResult>>

UpdateSmartFolder(UpdateSmartFolderArguments, CancellationToken)

public Task<ICommandResponse<UpdateSmartFolderResult>> UpdateSmartFolder(UpdateSmartFolderArguments args, CancellationToken cancellationToken)

Parameters

args UpdateSmartFolderArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<UpdateSmartFolderResult>>

UpdateSmartFolderProperties(UpdateSmartFolderPropertiesArguments, CancellationToken)

public Task<ICommandResponse<UpdateSmartFolderPropertiesResult>> UpdateSmartFolderProperties(UpdateSmartFolderPropertiesArguments args, CancellationToken cancellationToken)

Parameters

args UpdateSmartFolderPropertiesArguments
cancellationToken CancellationToken

Returns

Task<ICommandResponse<UpdateSmartFolderPropertiesResult>>

UploadChunk(MassAssetUploadChunkCommandArguments, CancellationToken)

Uploads single chunk of the file.

public Task<ICommandResponse<MassAssetUploadChunkCommandResult>> UploadChunk(MassAssetUploadChunkCommandArguments args, CancellationToken cancellationToken)

Parameters

args MassAssetUploadChunkCommandArguments

Upload chunk command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<MassAssetUploadChunkCommandResult>>