Class ContentHubList
Content hub listing page.
public sealed class ContentHubList : ListingPage<ContentHubListClientProperties>, IPage
- Inheritance
-
objectContentHubList
- 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
IContentItemManagerFactoryuserAccessor
IAuthenticatedUserAccessorcontentItemLanguageMetadataInfoProvider
IInfoProvider<ContentItemLanguageMetadataInfo>formComponentCommandInvoker
IFormComponentCommandInvokercontentItemsAdminPublisher
IContentItemsAdminPublisherpublishabilityCheckTableRetriever
IPublishabilityCheckTableRetrievercascadePublishTableRetriever
ICascadePublishTableRetrievercontentHubActionsTableClientPropertiesConfigurator
IContentHubActionsTableClientPropertiesConfiguratorformDataBinder
IFormDataBindersmartFoldersProvider
IInfoProvider<SmartFolderInfo>contentItemReferenceInfoProvider
IInfoProvider<ContentItemReferenceInfo>contentLanguageInfoProvider
IInfoProvider<ContentLanguageInfo>
Properties
ContentLanguageIdentifier
Page parameters.
[PageParameter(typeof(ContentLanguageModelBinder), typeof(ContentHubContentLanguage))]
public ContentLanguageUrlIdentifier ContentLanguageIdentifier { get; set; }
Property Value
FolderId
Folder identifier.
[PageParameter(typeof(ContentFolderModelBinder), typeof(ContentHubFolder))]
public ContentFolderId FolderId { get; set; }
Property Value
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
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
FormSubmissionCommandArgumentsForm change arguments.
cancellationToken
CancellationTokenCancellation instruction.
Returns
CloneSmartFolder(CloneSmartFolderArguments, CancellationToken)
Routes the command to the CloneSmartFolder(CloneSmartFolderArguments, int, CancellationToken) method.
public Task<ICommandResponse<CloneSmartFolderResult>> CloneSmartFolder(CloneSmartFolderArguments args, CancellationToken cancellationToken)
Parameters
args
CloneSmartFolderArgumentscancellationToken
CancellationToken
Returns
CompleteUpload(CompleteMassAssetUploadCommandArguments, CancellationToken)
Completes the upload of the file.
public Task<ICommandResponse<CompleteMassAssetUploadCommandResult>> CompleteUpload(CompleteMassAssetUploadCommandArguments args, CancellationToken cancellationToken)
Parameters
args
CompleteMassAssetUploadCommandArgumentsComplete upload command arguments.
cancellationToken
CancellationTokenCancellation token.
Returns
ComponentCommand(FormComponentCommandModel, CancellationToken)
Handles the form component command invocation.
public override Task<object> ComponentCommand(FormComponentCommandModel commandModel, CancellationToken cancellationToken)
Parameters
commandModel
FormComponentCommandModelForm component command arguments.
cancellationToken
CancellationTokenThe 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
ContentHubListClientPropertiesInitialized properties object.
Returns
CreateFolder(CreateFolderArguments, CancellationToken)
Routes the command to the CreateFolder(CreateFolderArguments, int, CancellationToken) method.
public Task<ICommandResponse<CreateFolderResult>> CreateFolder(CreateFolderArguments args, CancellationToken cancellationToken)
Parameters
args
CreateFolderArgumentscancellationToken
CancellationToken
Returns
CreateSmartFolder(CreateSmartFolderArguments, CancellationToken)
Routes the command to the CreateSmartFolder(CreateSmartFolderArguments, int, CancellationToken) method.
public Task<ICommandResponse<CreateSmartFolderResult>> CreateSmartFolder(CreateSmartFolderArguments args, CancellationToken cancellationToken)
Parameters
args
CreateSmartFolderArgumentscancellationToken
CancellationToken
Returns
CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken)
Routes the command to the CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments, CancellationToken, int?, bool) method.
public Task<ICommandResponse<CreateSmartFolderConfirmFilterResult>> CreateSmartFolderConfirmFilter(CreateSmartFolderConfirmFilterArguments args, CancellationToken cancellationToken)
Parameters
args
CreateSmartFolderConfirmFilterArgumentscancellationToken
CancellationToken
Returns
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)
Routes the command to the DeleteFolder(DeleteFolderArguments, int, CancellationToken) method.
public Task<ICommandResponse<DeleteFolderResult>> DeleteFolder(DeleteFolderArguments args, CancellationToken cancellationToken)
Parameters
args
DeleteFolderArgumentscancellationToken
CancellationToken
Returns
DeleteSmartFolder(DeleteSmartFolderArguments, CancellationToken)
Routes the command to the DeleteSmartFolder(DeleteSmartFolderArguments, CancellationToken) method.
public Task<ICommandResponse> DeleteSmartFolder(DeleteSmartFolderArguments args, CancellationToken cancellationToken)
Parameters
args
DeleteSmartFolderArgumentscancellationToken
CancellationToken
Returns
- Task<ICommandResponse>
DoesFilterSupportDelivery(FilterDeliverySupportArguments, CancellationToken)
Routes the command to the DoesFilterSupportDelivery(FilterDeliverySupportArguments, CancellationToken) method.
public Task<ICommandResponse<FilterDeliverySupportResult>> DoesFilterSupportDelivery(FilterDeliverySupportArguments args, CancellationToken cancellationToken = default)
Parameters
args
FilterDeliverySupportArgumentscancellationToken
CancellationToken
Returns
EnableContentDeliveryForSmartFolder(EnableContentDeliveryForSmartFolderArguments, CancellationToken)
Routes the command to the EnableContentDeliveryForSmartFolder(EnableContentDeliveryForSmartFolderArguments, CancellationToken) method.
public Task<ICommandResponse> EnableContentDeliveryForSmartFolder(EnableContentDeliveryForSmartFolderArguments args, CancellationToken cancellationToken)
Parameters
args
EnableContentDeliveryForSmartFolderArgumentscancellationToken
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
GetFolderArgumentscancellationToken
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
GetFolderArgumentscancellationToken
CancellationToken
Returns
- Task<ICommandResponse<ICollection<Folder>>>
GetFolderSubtree(GetFolderArguments, CancellationToken)
Routes the command to the GetFolderSubtree(GetFolderArguments, CancellationToken) method.
public Task<ICommandResponse<Folder>> GetFolderSubtree(GetFolderArguments args, CancellationToken cancellationToken)
Parameters
args
GetFolderArgumentscancellationToken
CancellationToken
Returns
- Task<ICommandResponse<Folder>>
GetFormItemsForCloneSmartFolder(GetFormItemsArguments, CancellationToken)
Routes the command to the GetFormItemsForCloneSmartFolder(GetFormItemsArguments, CancellationToken) method.
public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForCloneSmartFolder(GetFormItemsArguments args, CancellationToken cancellationToken)
Parameters
args
GetFormItemsArgumentscancellationToken
CancellationToken
Returns
GetFormItemsForCreateFolder(GetFormItemsArguments, CancellationToken)
Routes the command to the GetFormItemsForCreateFolder(GetFormItemsArguments, CancellationToken) method.
public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForCreateFolder(GetFormItemsArguments args, CancellationToken cancellationToken)
Parameters
args
GetFormItemsArgumentscancellationToken
CancellationToken
Returns
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
GetFormItemsForFolderProperties(GetFormItemsArguments, CancellationToken)
Routes the command to the GetFormItemsForFolderProperties(GetFormItemsArguments, CancellationToken) method.
public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForFolderProperties(GetFormItemsArguments args, CancellationToken cancellationToken)
Parameters
args
GetFormItemsArgumentscancellationToken
CancellationToken
Returns
GetFormItemsForMoveFolder(GetFormItemsArguments, CancellationToken)
Routes the command to the GetFormItemsForMoveFolder(GetFormItemsArguments, CancellationToken) method.
public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForMoveFolder(GetFormItemsArguments args, CancellationToken cancellationToken)
Parameters
args
GetFormItemsArgumentscancellationToken
CancellationToken
Returns
GetFormItemsForRenameFolder(GetFormItemsArguments, CancellationToken)
Routes the command to the GetFormItemsForRenameFolder(GetFormItemsArguments, CancellationToken) method.
public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForRenameFolder(GetFormItemsArguments args, CancellationToken cancellationToken)
Parameters
args
GetFormItemsArgumentscancellationToken
CancellationToken
Returns
GetFormItemsForRenameSmartFolder(GetFormItemsArguments, CancellationToken)
Routes the command to the GetFormItemsForRenameSmartFolder(GetFormItemsArguments, CancellationToken) method.
public Task<ICommandResponse<GetFormItemsResult>> GetFormItemsForRenameSmartFolder(GetFormItemsArguments args, CancellationToken cancellationToken)
Parameters
args
GetFormItemsArgumentscancellationToken
CancellationToken
Returns
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
GetFormItemsForSmartFolderProperties(GetFormItemsForSmartFolderPropertiesArguments, CancellationToken)
Routes the command to the GetFormItemsForSmartFolderProperties(GetFormItemsForSmartFolderPropertiesArguments, CancellationToken) method.
public Task<ICommandResponse<GetFormItemsForSmartFolderPropertiesResult>> GetFormItemsForSmartFolderProperties(GetFormItemsForSmartFolderPropertiesArguments args, CancellationToken cancellationToken)
Parameters
args
GetFormItemsForSmartFolderPropertiesArgumentscancellationToken
CancellationToken
Returns
GetSmartFolderFilter(GetSmartFolderFilterArguments, CancellationToken)
Routes the command to the GetSmartFolderFilter(GetSmartFolderFilterArguments, CancellationToken) method.
public Task<ICommandResponse<GetSmartFolderFilterResult>> GetSmartFolderFilter(GetSmartFolderFilterArguments args, CancellationToken cancellationToken)
Parameters
args
GetSmartFolderFilterArgumentscancellationToken
CancellationToken
Returns
GetSmartFolders(CancellationToken)
Routes the command to the GetSmartFolders(GetSmartFoldersArguments, CancellationToken) method.
public Task<ICommandResponse<GetSmartFoldersResult>> GetSmartFolders(CancellationToken cancellationToken)
Parameters
cancellationToken
CancellationToken
Returns
IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments, CancellationToken)
Routes the command to the IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments, CancellationToken) method.
public Task<ICommandResponse<SmartFolderDeliverySupportResult>> IsSmartFolderDeliverySupported(SmartFolderDeliverySupportArguments args, CancellationToken cancellationToken = default)
Parameters
args
SmartFolderDeliverySupportArgumentscancellationToken
CancellationToken
Returns
LoadData(LoadDataSettings, CancellationToken)
Returns LoadDataResult containing data and the number of total items.
protected override Task<LoadDataResult> LoadData(LoadDataSettings settings, CancellationToken cancellationToken)
Parameters
settings
LoadDataSettingsLoad data settings.
cancellationToken
CancellationTokenCancellation 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
LoadDeleteTableItemsCommandArgumentsLoad data command arguments.
cancellationToken
CancellationTokenCancellation 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
MoveContentItemModelModel describing where to move the content items.
cancellationToken
CancellationTokenCancellation 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
LoadCascadePublishTableItemsCommandArgumentsLoad data command arguments.
cancellationToken
CancellationTokenCancellation 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
intId of the content item to be moved.
model
MoveContentItemModelModel describing where to move the content item.
cancellationToken
CancellationTokenCancellation instruction.
Returns
- Task<ICommandResponse<RowActionResult>>
MoveFolder(MoveFolderArguments, CancellationToken)
Routes the command to the MoveFolder(MoveFolderArguments, int, CancellationToken) method.
public Task<ICommandResponse<MoveFolderResult>> MoveFolder(MoveFolderArguments args, CancellationToken cancellationToken)
Parameters
args
MoveFolderArgumentscancellationToken
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
FormChangeCommandArgumentsForm change command arguments.
cancellationToken
CancellationTokenCancellation 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
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
PublishabilityCheckLoadItemsCommandArgumentsLoad data command arguments.
cancellationToken
CancellationTokenCancellation token.
Returns
- Task<ICommandResponse<LoadDataResult>>
RenameFolder(RenameFolderArguments, CancellationToken)
Routes the command to the RenameFolder(RenameFolderArguments, int, CancellationToken) method.
public Task<ICommandResponse<RenameFolderResult>> RenameFolder(RenameFolderArguments args, CancellationToken cancellationToken)
Parameters
args
RenameFolderArgumentscancellationToken
CancellationToken
Returns
RenameSmartFolder(RenameSmartFolderArguments, CancellationToken)
Routes the command to the RenameSmartFolder(RenameSmartFolderArguments, CancellationToken) method.
public Task<ICommandResponse<RenameFolderResult>> RenameSmartFolder(RenameSmartFolderArguments args, CancellationToken cancellationToken)
Parameters
args
RenameSmartFolderArgumentscancellationToken
CancellationToken
Returns
SaveSmartFolder(SaveSmartFolderArguments, CancellationToken)
Routes the command to the SaveSmartFolder(SaveSmartFolderArguments, int, CancellationToken) method.
public Task<ICommandResponse<SaveSmartFolderResult>> SaveSmartFolder(SaveSmartFolderArguments args, CancellationToken cancellationToken)
Parameters
args
SaveSmartFolderArgumentscancellationToken
CancellationToken
Returns
UpdateFolderProperties(UpdateFolderPropertiesArguments, CancellationToken)
Routes the command to the UpdateFolderProperties(UpdateFolderPropertiesArguments, int, CancellationToken) method.
public Task<ICommandResponse<UpdateFolderPropertiesResult>> UpdateFolderProperties(UpdateFolderPropertiesArguments args, CancellationToken cancellationToken)
Parameters
args
UpdateFolderPropertiesArgumentscancellationToken
CancellationToken
Returns
UpdateSmartFolder(UpdateSmartFolderArguments, CancellationToken)
Routes the command to the UpdateSmartFolder(UpdateSmartFolderArguments, CancellationToken) method.
public Task<ICommandResponse<UpdateSmartFolderResult>> UpdateSmartFolder(UpdateSmartFolderArguments args, CancellationToken cancellationToken)
Parameters
args
UpdateSmartFolderArgumentscancellationToken
CancellationToken
Returns
UpdateSmartFolderProperties(UpdateSmartFolderPropertiesArguments, CancellationToken)
Routes the command to the UpdateSmartFolderProperties(UpdateSmartFolderPropertiesArguments, CancellationToken) method.
public Task<ICommandResponse<UpdateSmartFolderPropertiesResult>> UpdateSmartFolderProperties(UpdateSmartFolderPropertiesArguments args, CancellationToken cancellationToken)
Parameters
args
UpdateSmartFolderPropertiesArgumentscancellationToken
CancellationToken
Returns
UploadChunk(MassAssetUploadChunkCommandArguments, CancellationToken)
Uploads single chunk of the file.
public Task<ICommandResponse<MassAssetUploadChunkCommandResult>> UploadChunk(MassAssetUploadChunkCommandArguments args, CancellationToken cancellationToken)
Parameters
args
MassAssetUploadChunkCommandArgumentsUpload chunk command arguments.
cancellationToken
CancellationTokenCancellation token.