Class MethodScheduledTaskAddIn

Namespace

Dynamicweb.Scheduling.ScheduledTaskAddIns

Assembly

Dynamicweb.Core.dll

Scheduled task provider MethodScheduledTaskAddIn makes it possible to execute method from Assembly

[AddInName("Dynamicweb.Scheduling.MethodAddIn.MethodAddIn")]
[AddInLabel("Execute method from Assembly")]
[AddInDescription("Executes method from Assembly")]
public class MethodScheduledTaskAddIn : BaseScheduledTaskAddIn, IParameterOptions, IDynamicParameterOptions

Inheritance

object

ConfigurableAddIn

BaseScheduledTaskAddIn

MethodScheduledTaskAddIn

Implements

IParameterOptions

IDynamicParameterOptions

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()

Properties

Assembly

[AddInParameter("Assembly")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "Info=Required;NewGUI=true;reloadOnChange=true;")]
public string? Assembly { get; set; }

Property Value

string

Class

[AddInParameter("Class")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "Info=Required;NewGUI=true;DynamicOptions=true;reloadOnChange=true;")]
public string? Class { get; set; }

Property Value

string

Method

[AddInParameter("Method")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "Info=Required;NewGUI=true;DynamicOptions=true;")]
public string? Method { get; set; }

Property Value

string

Namespace

[AddInParameter("Namespace")]
[AddInParameterEditor(typeof(DropDownParameterEditor), "Info=Required;NewGUI=true;DynamicOptions=true;reloadOnChange=true;")]
public string? Namespace { get; set; }

Property Value

string

Parameters

[AddInParameter("Parameters")]
[AddInParameterEditor(typeof(TextParameterEditor), "inputClass=NewUIinput;")]
public string? Parameters { get; set; }

Property Value

string

Methods

GetAssemblies()

public static HashSet<string> GetAssemblies()

Returns

HashSet<string>

GetClasses(string, string)

public HashSet<string> GetClasses(string assemblyName, string assemblyNamespace)

Parameters

assemblyName string

assemblyNamespace string

Returns

HashSet<string>

GetMethodsFromClass(string, string, string)

public IEnumerable<string> GetMethodsFromClass(string assemblyName, string assemblyNamespace, string className)

Parameters

assemblyName string

assemblyNamespace string

className string

Returns

IEnumerable<string>

GetNameSpaces(string)

public HashSet<string> GetNameSpaces(string assemblyName)

Parameters

assemblyName string

Returns

HashSet<string>

GetParameterOptions(string, Func<string, object?>)

public IEnumerable<ParameterOption> GetParameterOptions(string parameterName, Func<string, object?> parameterValueLookup)

Parameters

parameterName string

parameterValueLookup Func<string, object>

Returns

IEnumerable<ParameterOption>

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.