Class UrlsTab

Namespace

Kentico.Xperience.Admin.Websites.UIPages

Assembly

Kentico.Xperience.Admin.Websites.dll

Page for web page URLs.

public sealed class UrlsTab : WebPageBase<UrlsTabClientProperties>, IPage

Inheritance

object

Page<UrlsTabClientProperties>

WebPageBase<UrlsTabClientProperties>

UrlsTab

Implements

IPage

Inherited Members

WebPageBase<UrlsTabClientProperties>.ConfigurePage()

WebPageBase<UrlsTabClientProperties>.ApplicationIdentifier

WebPageBase<UrlsTabClientProperties>.WebPageIdentifier

Page<UrlsTabClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

UrlsTab(IAuthenticatedUserAccessor, IWebPageManagerFactory, IPageLinkGenerator)

Initializes a new instance of UrlsTab

public UrlsTab(IAuthenticatedUserAccessor userAccessor, IWebPageManagerFactory webPageManagerFactory, IPageLinkGenerator pageLinkGenerator)

Parameters

userAccessor IAuthenticatedUserAccessor

webPageManagerFactory IWebPageManagerFactory

pageLinkGenerator IPageLinkGenerator

Methods

CancelScheduledPublish(CancellationToken)

Cancels scheduled publish of the web page.

[PageCommand(CommandName = "CancelScheduledPublish", Permission = "View")]
public Task<ICommandResponse> CancelScheduledPublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledPublishAndEdit(CancellationToken)

Cancels scheduled publish of the web page and allows edit.

[PageCommand(CommandName = "CancelScheduledPublishAndEdit", Permission = "View")]
public Task<ICommandResponse> CancelScheduledPublishAndEdit(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledUnpublish(CancellationToken)

Cancels scheduled unpublish of the web page.

[PageCommand(CommandName = "CancelScheduledUnpublish", Permission = "View")]
public Task<ICommandResponse> CancelScheduledUnpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ChangeWorkflowStep(PublishUrlsTabWebPageCommandArguments, CancellationToken)

Changes the web page workflow step.

[PageCommand(CommandName = "ChangeWorkflowStep", Permission = "View")]
public Task<ICommandResponse> ChangeWorkflowStep(PublishUrlsTabWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishUrlsTabWebPageCommandArguments

Change workflow step submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ConfigureTemplateProperties(UrlsTabClientProperties)

Gets the object representing client side template properties.

public override Task<UrlsTabClientProperties> ConfigureTemplateProperties(UrlsTabClientProperties properties)

Parameters

properties UrlsTabClientProperties

Initialized properties object.

Returns

Task<UrlsTabClientProperties>

CreateNewVersion(CancellationToken)

Creates new Draft version of a web page.

[PageCommand(CommandName = "CreateNewVersion", Permission = "View")]
public Task<ICommandResponse> CreateNewVersion(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Discard(CancellationToken)

Discards the Draft version of web page.

[PageCommand(CommandName = "Discard", Permission = "View")]
public Task<ICommandResponse> Discard(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

EditUrlChange(EditUrlFormChangeCommandArguments, CancellationToken)

Handles the edit URL 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.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<FormChangeResult>> EditUrlChange(EditUrlFormChangeCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args EditUrlFormChangeCommandArguments

Edit URL form change command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<FormChangeResult>>

GenerateShareablePreviewUrl(CancellationToken)

Generates a shareable preview URL for the web page language variant.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<GenerateShareablePreviewUrlCommandResult>> GenerateShareablePreviewUrl(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GenerateShareablePreviewUrlCommandResult>>

GetEditUrlFormComponents(GetEditUrlFormComponentsCommandArguments, CancellationToken)

Gets the form components for the edit URL form.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<GetUrlFormComponentsCommandResult>> GetEditUrlFormComponents(GetEditUrlFormComponentsCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args GetEditUrlFormComponentsCommandArguments

Get edit URL form components command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<GetUrlFormComponentsCommandResult>>

Publish(PublishUrlsTabWebPageCommandArguments, CancellationToken)

Updates the web page and redirects to the publish page.

[PageCommand(CommandName = "Publish", Permission = "View")]
public Task<ICommandResponse> Publish(PublishUrlsTabWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishUrlsTabWebPageCommandArguments

Publish web page submit arguments

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Rename(RenameCommandArguments, CancellationToken)

Updates web pages display name.

[PageCommand(Permission = "View")]
public Task<ICommandResponse> Rename(RenameCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args RenameCommandArguments

Rename command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Save(UrlsSubmissionCommandArguments, CancellationToken)

Saves page data changes.

[PageCommand(CommandName = "Save", Permission = "View")]
public Task<ICommandResponse> Save(UrlsSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args UrlsSubmissionCommandArguments

Submission arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

ShareablePreview(ShareablePreviewUrlWebPageCommandArguments, CancellationToken)

Redirects to the page with shareable preview.

[PageCommand(CommandName = "ShareablePreview", Permission = "View")]
public Task<ICommandResponse> ShareablePreview(ShareablePreviewUrlWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args ShareablePreviewUrlWebPageCommandArguments

ShareablePreview web page submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

StopShareablePreview()

Stops shareable preview for the web page language variant.

[PageCommand(Permission = "View")]
public Task<ICommandResponse> StopShareablePreview()

Returns

Task<ICommandResponse>

SubmitUrlEditForm(UrlEditFormSubmissionCommandArguments, CancellationToken)

Edit URL form submission.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<UrlEditFormSubmissionCommandResult>> SubmitUrlEditForm(UrlEditFormSubmissionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args UrlEditFormSubmissionCommandArguments

Edit URL form submission command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<UrlEditFormSubmissionCommandResult>>

Unpublish(CancellationToken)

Redirects to the page with unpublishing options.

[PageCommand(CommandName = "Unpublish", Permission = "View")]
public Task<ICommandResponse> Unpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Versions(UrlVersionsWebPageCommandArguments, CancellationToken)

Redirects to the page with web page versions.

[PageCommand(CommandName = "Versions", Permission = "View")]
public Task<ICommandResponse> Versions(UrlVersionsWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args UrlVersionsWebPageCommandArguments

Versions web page submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>