Class UserScriptBase

Namespace

ArcanaDevelopment.adTempus.ApplicationIntegration

Assembly

ArcanaDevelopment.adTempus.ApplicationIntegration.dll

Base class for all user scripts.

[Serializable]
public abstract class UserScriptBase : MarshalByRefObject

Inheritance

object

MarshalByRefObject

UserScriptBase

Derived

ConditionScriptBase

TypedUserScriptBase<ParametersInterface, ParametersClass>

Remarks

All user scripts run in adTempus are implemented in a class that derives from UserScriptBase.
Depending on the purpose for which the script was created, it may inherit from a specialization of UserScriptBase. For example, a script created for use by a File Trigger will inherit from FileTriggerScriptBase.

Properties

IsTerminated

Indicates whether termination has been requested for the script.

protected bool IsTerminated { get; }

Property Value

bool

Parameters

Gets the parameters for the script.

public virtual IScriptParameters Parameters { get; }

Property Value

IScriptParameters

Remarks

The type of the Parameters object will depend on the context in which the script is being used. For example, if the script is being run by a File Trigger, the parameters will be of type FileTriggerScriptParameters.

TerminationWaitHandle

WaitHandle that can be used to wait for script termination

protected WaitHandle TerminationWaitHandle { get; }

Property Value

WaitHandle

Remarks

This handle is signaled when Terminate is called.

Methods

OnTerminate()

Called when the script is being aborted.

protected virtual void OnTerminate()

Remarks

Override to take additional actions when the script is aborted. Your script must complete any cleanup/shutdown actions within 10 seconds; after that the script will be forcibly terminated.

Run()

Runs the script.

public abstract object Run()

Returns

object

Remarks

This method is intended for use by adTempus.