jellyfin/MediaBrowser.Common/ScheduledTasks/ITaskTrigger.cs

35 lines
1.0 KiB
C#

using System;
using MediaBrowser.Model.Events;
namespace MediaBrowser.Common.ScheduledTasks
{
/// <summary>
/// Interface ITaskTrigger
/// </summary>
public interface ITaskTrigger
{
/// <summary>
/// Fires when the trigger condition is satisfied and the task should run
/// </summary>
event EventHandler<GenericEventArgs<TaskExecutionOptions>> Triggered;
/// <summary>
/// Stars waiting for the trigger action
/// </summary>
/// <param name="isApplicationStartup">if set to <c>true</c> [is application startup].</param>
void Start(bool isApplicationStartup);
/// <summary>
/// Stops waiting for the trigger action
/// </summary>
void Stop();
/// <summary>
/// Gets or sets the execution properties of this task.
/// </summary>
/// <value>
/// The execution properties of this task.
/// </value>
TaskExecutionOptions TaskOptions { get; set; }
}
}