diff options
Diffstat (limited to 'MediaBrowser.Controller/Events')
| -rw-r--r-- | MediaBrowser.Controller/Events/IEventConsumer.cs | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/Events/IEventConsumer.cs b/MediaBrowser.Controller/Events/IEventConsumer.cs index 3cefe2f9c8..5c4ab5d8dd 100644 --- a/MediaBrowser.Controller/Events/IEventConsumer.cs +++ b/MediaBrowser.Controller/Events/IEventConsumer.cs @@ -3,9 +3,18 @@ using System.Threading.Tasks; namespace MediaBrowser.Controller.Events { + /// <summary> + /// An interface representing a type that consumes events of type <c>T</c>. + /// </summary> + /// <typeparam name="T">The type of events this consumes.</typeparam> public interface IEventConsumer<in T> where T : EventArgs { + /// <summary> + /// A method that is called when an event of type <c>T</c> is fired. + /// </summary> + /// <param name="eventArgs">The event.</param> + /// <returns>A task representing the consumption of the event.</returns> Task OnEvent(T eventArgs); } } |
