Managers.IScheduledTaskManager Interface
Namespace: Nucleus.Abstractions.Managers
Assembly: Nucleus.Abstractions.dll
Defines the interface for the scheduled task manager.
Remarks
Get an instance of this class from dependency injection by including a parameter in your class constructor.
Methods
CreateNew
CreateNew ()
Create a new Models.TaskScheduler.ScheduledTask with default values.
Remarks
This function does not save the new Models.TaskScheduler.ScheduledTask to the database. Call Save to save the role group.
Get (Guid) Method
Get (Guid id)
Retrieve an existing Models.TaskScheduler.ScheduledTask from the database.
Parameters
| Name | Type |
|---|---|
| id | Guid |
List (PagingSettings) Method
List (Nucleus.Abstractions.Models.Paging.PagingSettings)
List Models.TaskScheduler.ScheduledTasks for the specified site.
ListBackgroundServices
ListBackgroundServices ()
Returns a list of installed Scheduled task classes.
SaveHistory (ScheduledTaskHistory) Method
SaveHistory (ScheduledTaskHistory history)
Create or update the specified Models.TaskScheduler.ScheduledTaskHistory.
Parameters
| Name | Type |
|---|---|
| history | Nucleus.Abstractions.Models.TaskScheduler.ScheduledTaskHistory |
TruncateHistory (ScheduledTask) Method
TruncateHistory (ScheduledTask scheduledTask)
Remove old history records.
Parameters
| Name | Type |
|---|---|
| scheduledTask | Nucleus.Abstractions.Models.TaskScheduler.ScheduledTask |
RunNow (ScheduledTask) Method
RunNow (ScheduledTask task)
Run the task immediately.
Parameters
| Name | Type |
|---|---|
| task | Nucleus.Abstractions.Models.TaskScheduler.ScheduledTask |
ListHistory (ScheduledTask) Method
ListHistory (ScheduledTask task)
Create or update the specified Models.TaskScheduler.ScheduledTaskHistory.
Parameters
| Name | Type |
|---|---|
| task | Nucleus.Abstractions.Models.TaskScheduler.ScheduledTask |
GetMostRecentHistory (ScheduledTask,String) Method
GetMostRecentHistory (ScheduledTask scheduledTask, String server)
Get the most recent scheduled task history for the specified server.
Parameters
| Name | Type |
|---|---|
| scheduledTask | Nucleus.Abstractions.Models.TaskScheduler.ScheduledTask |
| server | String |
Remarks
Specify NULL for the server name to ignore the server name.
Save (ScheduledTask) Method
Save (ScheduledTask scheduledTask)
Create or update the specified Models.TaskScheduler.ScheduledTask.
Parameters
| Name | Type |
|---|---|
| scheduledTask | Nucleus.Abstractions.Models.TaskScheduler.ScheduledTask |
Delete (ScheduledTask) Method
Delete (ScheduledTask scheduledTask)
Delete the specified Models.TaskScheduler.ScheduledTask from the database.
Parameters
| Name | Type |
|---|---|
| scheduledTask | Nucleus.Abstractions.Models.TaskScheduler.ScheduledTask |