Class ApiScheduler

Inheritance
object
BaseHasChildren<EPCommandWithDescriptor>
EPCommand
EPCommandWithDescriptor
ViewCommand
TaskBase
ApiScheduler
Implements
Inherited Members
Namespace: LemonEdge.ApiConnector.UI
Assembly: LemonEdge.ApiConnector.UI.dll
Syntax
public class ApiScheduler : TaskBase, IHasChildren<EPCommandWithDescriptor>, IHasChildren, IDisposable, IEPCommandWithDescriptor, IEPCommand, ICommand, ICommandDescriptor

Constructors

ApiScheduler(IRootController, IModelLayoutCommon, bool)

Declaration
public ApiScheduler(IRootController root, IModelLayoutCommon owner, bool runOnServer)
Parameters
Type Name Description
IRootController root
IModelLayoutCommon owner
bool runOnServer

Methods

GetParameters()

A function that returns the default parameters to use when creating this task

Used in conjunction with GetUserModifiedParametersFromDefault(IModelLayoutCommon, ServerTaskParameter) so hardcoded values can automatically be set, and the user can be prompted for any other required parameter selections if required

Declaration
protected override Task<ServerTaskParameter> GetParameters()
Returns
Type Description
Task<ServerTaskParameter>

A task with the parameters, allowing optional popups to be shown to the user for parameter selection
Overrides
Remarks

For instance:

protected override Task<ServerTaskParameter> GetParameters()
{
    var ps = new API.Tasks.Parameters.ResetAccountParameter();
    ps.AccountID = accountID;
    ps.AccountID_Label = accountName;
    return GetUserModifiedParametersFromDefault(Owner, ps);
}

Implements

Extension Methods