Class ServerTaskParametersAttribute
This attribute can be used to mark any implementation of the ServerTaskParameter class for defining parameters for a ITaskProcessor implementation
It is optional if the ITaskProcessor implementation is accessible from all UI clients, as that ServerTaskAttribute contains all the details.
If the ITaskProcessor is not always accessible then the ServerTaskParameter *must* be marked with this to provide detail on how to create parameters for the task and send to the server for processingInherited Members
Namespace: LemonEdge.API.Tasks
Assembly: API.dll
Syntax
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
public class ServerTaskParametersAttribute : Attribute
Constructors
ServerTaskParametersAttribute(String, String)
Creates a new instance of the server task parameters attribute for describing a ServerTaskParameter implementation
Declaration
public ServerTaskParametersAttribute(string userFriendlyTaskName, string uniqueTaskID)
Parameters
Type | Name | Description |
---|---|---|
System.String | userFriendlyTaskName | The user friendly name of the task type |
System.String | uniqueTaskID | The globally unique System.Guid id for this task. Used in UniqueTaskID too. |
Properties
DefaultForHasSaveProcessingTask
If this task works against an entity in the system that implements IHasSaveProcessingTask, then that type can be specified here and the Save command can integrate with it
The integration automatically creates the task during save or provide parameters for it depending on the ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater) implementation
Declaration
public Type DefaultForHasSaveProcessingTask { get; set; }
Property Value
Type | Description |
---|---|
System.Type |
Description
A user friendly description of this tasks operation
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Name
The user friendly name of the task type
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
System.String |
UniqueTaskID
The globally unique id for this task. Used in UniqueTaskID too.
Declaration
public Guid UniqueTaskID { get; }
Property Value
Type | Description |
---|---|
System.Guid |