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>.ApplicationIdentifier

WebPageBase<UrlsTabClientProperties>.WebPageIdentifier

WebPageBase<UrlsTabClientProperties>.ConfigurePage()

Page<UrlsTabClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

UrlsTab(IAuthenticatedUserAccessor, IWebPageManagerFactory, IContentItemUIDataRetriever, IPageLinkGenerator)

Initializes a new instance of UrlsTab

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

Parameters

userAccessor IAuthenticatedUserAccessor

webPageManagerFactory IWebPageManagerFactory

contentItemUIDataRetriever IContentItemUIDataRetriever

pageLinkGenerator IPageLinkGenerator

Methods

CancelScheduledPublish(CancellationToken)

Cancels scheduled publish of the web page.

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.

public Task<ICommandResponse> CancelScheduledPublishAndEdit(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

CancelScheduledUnpublish(CancellationToken)

Cancels scheduled unpublish of the web page.

public Task<ICommandResponse> CancelScheduledUnpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Change(FormChangeCommandArguments, CancellationToken)

Handles the 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<FormChangeResult>> Change(FormChangeCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args FormChangeCommandArguments

Form change arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<FormChangeResult>>

ChangeWorkflowStep(PublishWebPageCommandArguments, CancellationToken)

Changes the web page workflow step.

public Task<ICommandResponse> ChangeWorkflowStep(PublishWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishWebPageCommandArguments

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.

public Task<ICommandResponse> CreateNewVersion(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Discard(CancellationToken)

Discards the Draft version of web page.

public Task<ICommandResponse> Discard(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Publish(PublishWebPageCommandArguments, CancellationToken)

Updates the web page and redirects to the publish page.

public Task<ICommandResponse> Publish(PublishWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args PublishWebPageCommandArguments

Publish web page submit arguments

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Rename(RenameCommandArguments, CancellationToken)

Updates web pages display name.

public Task<ICommandResponse> Rename(RenameCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args RenameCommandArguments

Rename command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Save(FormSubmissionCommandArguments, CancellationToken)

Saves page data changes.

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

Parameters

args FormSubmissionCommandArguments

Submission arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Unpublish(CancellationToken)

Redirects to the page with unpublishing options.

public Task<ICommandResponse> Unpublish(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Versions(VersionsWebPageCommandArguments, CancellationToken)

Redirects to the page with web page versions.

public Task<ICommandResponse> Versions(VersionsWebPageCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args VersionsWebPageCommandArguments

Versions web page submit arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>