aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model/Tasks/ITaskTrigger.cs
blob: 5c30d6c2207855041e0a7c26105aaf3592b02ab0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
using System;
using Microsoft.Extensions.Logging;

namespace MediaBrowser.Model.Tasks
{
    /// <summary>
    /// Interface ITaskTrigger.
    /// </summary>
    public interface ITaskTrigger
    {
        /// <summary>
        /// Fires when the trigger condition is satisfied and the task should run.
        /// </summary>
        event EventHandler<EventArgs> Triggered;

        /// <summary>
        /// Gets or sets the options of this task.
        /// </summary>
        TaskOptions TaskOptions { get; set; }

        /// <summary>
        /// Stars waiting for the trigger action.
        /// </summary>
        void Start(TaskResult lastResult, ILogger logger, string taskName, bool isApplicationStartup);

        /// <summary>
        /// Stops waiting for the trigger action.
        /// </summary>
        void Stop();
    }
}