Class AssetsCheckinScheduledTaskAddIn

Namespace

Dynamicweb.Ecommerce.Products.ScheduledTaskAddIns

Assembly

Dynamicweb.Ecommerce.dll

[AddInName("Extensibility.ScheduledTaskAddins.AssetsCheckinTaskAddIn")]
[AddInUseParameterOrdering(true)]
[AddInLabel("Digital assets checkin on Products")]
[AddInDescription("Digital assets checkin on Products based on checkin rules set on Asset Groups.")]
[AddInIgnore(false)]
[AddInUseParameterGrouping(true)]
public class AssetsCheckinScheduledTaskAddIn : BaseScheduledTaskAddIn, IParameterOptions

Inheritance

object

ConfigurableAddIn

BaseScheduledTaskAddIn

AssetsCheckinScheduledTaskAddIn

Implements

IParameterOptions

Inherited Members

BaseScheduledTaskAddIn.ScheduledTaskName

BaseScheduledTaskAddIn.Task

BaseScheduledTaskAddIn.CancellationToken

BaseScheduledTaskAddIn.IsCancellationTokenUsed

BaseScheduledTaskAddIn.HostUrl

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AssetsCheckinScheduledTaskAddIn()

public AssetsCheckinScheduledTaskAddIn()

Fields

TaskName

public const string TaskName = "Assets checkin"

Field Value

string

Properties

AssetsCategories

[AddInLabel("Assets category")]
[AddInParameter("AssetsCategories")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=All;rightheader=Selected;translateheaders=true;showsearchbox=true")]
public string? AssetsCategories { get; set; }

Property Value

string

CheckinMode

[AddInLabel("Mode")]
[AddInParameter("CheckinMode")]
[AddInParameterEditor(typeof(RadioParameterEditor), "inputClass=inputControl")]
public string CheckinMode { get; set; }

Property Value

string

PartialRun

[AddInLabel("Partial run")]
[AddInParameter("PartialRun")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "inputClass=inputControl")]
public bool PartialRun { get; set; }

Property Value

bool

StartFolder

[AddInLabel("Start Folder")]
[AddInParameter("StartFolder")]
[AddInParameterEditor(typeof(FolderSelectEditor), "inputClass=inputControl")]
public string? StartFolder { get; set; }

Property Value

string

Methods

GetParameterOptions(string)

public IEnumerable<ParameterOption> GetParameterOptions(string parameterName)

Parameters

parameterName string

Returns

IEnumerable<ParameterOption>

Install()

Installs this provider.

public static void Install()

IsInstalled()

Determines whether this provider is installed.

public static bool IsInstalled()

Returns

bool

true if this instance is installed; otherwise, false.

Run()

Performs the work of the scheduled task. Called once per task run, after the framework has populated the context properties and loaded the saved parameter values.

public override bool Run()

Returns

bool

true when the work succeeded; otherwise false. The value is logged and stored as the task's last result. Exceptions that escape this method are caught by the framework, logged, and recorded as a failed run.