94 lines
3.5 KiB
C#
94 lines
3.5 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using System.Threading.Tasks;
|
|
using Umbraco.Core.Models;
|
|
using Umbraco.Core.Models.Entities;
|
|
using Umbraco.Core.Models.Membership;
|
|
using Umbraco.Core.Persistence;
|
|
|
|
namespace Umbraco.Core.Services
|
|
{
|
|
public interface INotificationService : IService
|
|
{
|
|
/// <summary>
|
|
/// Sends the notifications for the specified user regarding the specified nodes and action.
|
|
/// </summary>
|
|
/// <param name="entities"></param>
|
|
/// <param name="operatingUser"></param>
|
|
/// <param name="action"></param>
|
|
/// <param name="actionName"></param>
|
|
/// <param name="siteUri"></param>
|
|
/// <param name="createSubject"></param>
|
|
/// <param name="createBody"></param>
|
|
void SendNotifications(IUser operatingUser, IEnumerable<IContent> entities, string action, string actionName, Uri siteUri,
|
|
Func<(IUser user, NotificationEmailSubjectParams subject), string> createSubject,
|
|
Func<(IUser user, NotificationEmailBodyParams body, bool isHtml), string> createBody);
|
|
|
|
/// <summary>
|
|
/// Gets the notifications for the user
|
|
/// </summary>
|
|
/// <param name="user"></param>
|
|
/// <returns></returns>
|
|
IEnumerable<Notification> GetUserNotifications(IUser user);
|
|
|
|
/// <summary>
|
|
/// Gets the notifications for the user based on the specified node path
|
|
/// </summary>
|
|
/// <param name="user"></param>
|
|
/// <param name="path"></param>
|
|
/// <returns></returns>
|
|
/// <remarks>
|
|
/// Notifications are inherited from the parent so any child node will also have notifications assigned based on it's parent (ancestors)
|
|
/// </remarks>
|
|
IEnumerable<Notification> GetUserNotifications(IUser user, string path);
|
|
|
|
/// <summary>
|
|
/// Returns the notifications for an entity
|
|
/// </summary>
|
|
/// <param name="entity"></param>
|
|
/// <returns></returns>
|
|
IEnumerable<Notification> GetEntityNotifications(IEntity entity);
|
|
|
|
/// <summary>
|
|
/// Deletes notifications by entity
|
|
/// </summary>
|
|
/// <param name="entity"></param>
|
|
void DeleteNotifications(IEntity entity);
|
|
|
|
/// <summary>
|
|
/// Deletes notifications by user
|
|
/// </summary>
|
|
/// <param name="user"></param>
|
|
void DeleteNotifications(IUser user);
|
|
|
|
/// <summary>
|
|
/// Delete notifications by user and entity
|
|
/// </summary>
|
|
/// <param name="user"></param>
|
|
/// <param name="entity"></param>
|
|
void DeleteNotifications(IUser user, IEntity entity);
|
|
|
|
/// <summary>
|
|
/// Sets the specific notifications for the user and entity
|
|
/// </summary>
|
|
/// <param name="user"></param>
|
|
/// <param name="entity"></param>
|
|
/// <param name="actions"></param>
|
|
/// <remarks>
|
|
/// This performs a full replace
|
|
/// </remarks>
|
|
IEnumerable<Notification> SetNotifications(IUser user, IEntity entity, string[] actions);
|
|
|
|
/// <summary>
|
|
/// Creates a new notification
|
|
/// </summary>
|
|
/// <param name="user"></param>
|
|
/// <param name="entity"></param>
|
|
/// <param name="action">The action letter - note: this is a string for future compatibility</param>
|
|
/// <returns></returns>
|
|
Notification CreateNotification(IUser user, IEntity entity, string action);
|
|
}
|
|
}
|