Class WebPageManagerSchedulingExtensions

Namespace

CMS.Websites

Assembly

CMS.Websites.dll

Extensions of IWebPageManager for scheduling.

public static class WebPageManagerSchedulingExtensions

Inheritance

object

WebPageManagerSchedulingExtensions

Methods

CancelScheduledPublish(IWebPageManager, int, string, CancellationToken)

Cancels scheduled publish of the web page.

[Obsolete("Use IWebPageManager.CancelScheduledPublish(int, string, CancellationToken) instead.")]
[ObsoleteSince(30, 1)]
public static Task CancelScheduledPublish(this IWebPageManager webPageManager, int webPageItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

webPageManager IWebPageManager

Web page manager.

webPageItemId int

Web page identifier.

languageName string

Language codename.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

Remarks

The method also cancels scheduled unpublish if it was set.

CancelScheduledUnpublish(IWebPageManager, int, string, CancellationToken)

Cancels scheduled unpublish of the web page.

[Obsolete("Use IWebPageManager.CancelScheduledUnpublish(int, string, CancellationToken) instead.")]
[ObsoleteSince(30, 1)]
public static Task CancelScheduledUnpublish(this IWebPageManager webPageManager, int webPageItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

webPageManager IWebPageManager

Web page manager.

webPageItemId int

Web page identifier.

languageName string

Language codename.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

IsPublishScheduled(IWebPageManager, int, string, CancellationToken)

Returns true when the web page is scheduled for publish.

public static Task<bool> IsPublishScheduled(this IWebPageManager webPageManager, int webPageItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

webPageManager IWebPageManager

Web page manager.

webPageItemId int

Web page identifier.

languageName string

Language codename.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

IsUnpublishScheduled(IWebPageManager, int, string, CancellationToken)

Returns true when the web page is scheduled for unpublish.

public static Task<bool> IsUnpublishScheduled(this IWebPageManager webPageManager, int webPageItemId, string languageName, CancellationToken cancellationToken = default)

Parameters

webPageManager IWebPageManager

Web page manager.

webPageItemId int

Web page identifier.

languageName string

Language codename.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<bool>

SchedulePublish(IWebPageManager, int, string, DateTime, CancellationToken)

Schedules publish of the web page.

[Obsolete("Use IWebPageManager.SchedulePublish(int, string, DateTime, CancellationToken) instead.")]
[ObsoleteSince(30, 1)]
public static Task SchedulePublish(this IWebPageManager webPageManager, int webPageItemId, string languageName, DateTime scheduledTime, CancellationToken cancellationToken = default)

Parameters

webPageManager IWebPageManager

Web page manager.

webPageItemId int

Web page identifier.

languageName string

Language codename.

scheduledTime DateTime

Date and time when the web page should be published.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task

ScheduleUnpublish(IWebPageManager, int, string, DateTime, CancellationToken)

Schedules unpublish of the web page.

[Obsolete("Use IWebPageManager.ScheduleUnpublish(int, string, DateTime, CancellationToken) instead.")]
[ObsoleteSince(30, 1)]
public static Task ScheduleUnpublish(this IWebPageManager webPageManager, int webPageItemId, string languageName, DateTime scheduledTime, CancellationToken cancellationToken = default)

Parameters

webPageManager IWebPageManager

Web page manager.

webPageItemId int

Web page identifier.

languageName string

Language codename.

scheduledTime DateTime

Date and time when the web page should be unpublished.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task