aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Notifications/INotificationsRepository.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Controller/Notifications/INotificationsRepository.cs')
-rw-r--r--MediaBrowser.Controller/Notifications/INotificationsRepository.cs76
1 files changed, 76 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/Notifications/INotificationsRepository.cs b/MediaBrowser.Controller/Notifications/INotificationsRepository.cs
new file mode 100644
index 000000000..8790b54f4
--- /dev/null
+++ b/MediaBrowser.Controller/Notifications/INotificationsRepository.cs
@@ -0,0 +1,76 @@
+using System.Threading;
+using MediaBrowser.Controller.Persistence;
+using MediaBrowser.Model.Notifications;
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace MediaBrowser.Controller.Notifications
+{
+ /// <summary>
+ /// Interface INotificationsRepository
+ /// </summary>
+ public interface INotificationsRepository
+ {
+ /// <summary>
+ /// Occurs when [notification added].
+ /// </summary>
+ event EventHandler<NotificationUpdateEventArgs> NotificationAdded;
+ /// <summary>
+ /// Occurs when [notification updated].
+ /// </summary>
+ event EventHandler<NotificationUpdateEventArgs> NotificationUpdated;
+ /// <summary>
+ /// Occurs when [notifications marked read].
+ /// </summary>
+ event EventHandler<NotificationReadEventArgs> NotificationsMarkedRead;
+
+ /// <summary>
+ /// Gets the notifications.
+ /// </summary>
+ /// <param name="query">The query.</param>
+ /// <returns>NotificationResult.</returns>
+ NotificationResult GetNotifications(NotificationQuery query);
+
+ /// <summary>
+ /// Gets the notification.
+ /// </summary>
+ /// <param name="id">The id.</param>
+ /// <param name="userId">The user id.</param>
+ /// <returns>Notification.</returns>
+ Notification GetNotification(Guid id, Guid userId);
+
+ /// <summary>
+ /// Adds the notification.
+ /// </summary>
+ /// <param name="notification">The notification.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>Task.</returns>
+ Task AddNotification(Notification notification, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Updates the notification.
+ /// </summary>
+ /// <param name="notification">The notification.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>Task.</returns>
+ Task UpdateNotification(Notification notification, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Marks the read.
+ /// </summary>
+ /// <param name="notificationIdList">The notification id list.</param>
+ /// <param name="userId">The user id.</param>
+ /// <param name="isRead">if set to <c>true</c> [is read].</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>Task.</returns>
+ Task MarkRead(IEnumerable<Guid> notificationIdList, Guid userId, bool isRead, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// Gets the notifications summary.
+ /// </summary>
+ /// <param name="userId">The user id.</param>
+ /// <returns>NotificationsSummary.</returns>
+ NotificationsSummary GetNotificationsSummary(Guid userId);
+ }
+}