jellyfin/MediaBrowser.Controller/Notifications/INotificationManager.cs

50 lines
1.7 KiB
C#
Raw Normal View History

2014-04-25 13:15:50 -07:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Notifications;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Notifications
{
public interface INotificationManager
{
/// <summary>
/// Sends the notification.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendNotification(NotificationRequest request, CancellationToken cancellationToken);
/// <summary>
/// Adds the parts.
/// </summary>
/// <param name="services">The services.</param>
void AddParts(IEnumerable<INotificationService> services);
}
public interface INotificationService
{
/// <summary>
/// Gets the name.
/// </summary>
/// <value>The name.</value>
string Name { get; }
/// <summary>
/// Sends the notification.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendNotification(UserNotification request, CancellationToken cancellationToken);
/// <summary>
/// Determines whether [is enabled for user] [the specified user identifier].
/// </summary>
/// <param name="user">The user.</param>
/// <returns><c>true</c> if [is enabled for user] [the specified user identifier]; otherwise, <c>false</c>.</returns>
bool IsEnabledForUser(User user);
}
}