Interface INotificationService
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public interface INotificationService : IService
Methods
CreateNotification(IUser, IEntity, String)
Creates a new notification
Declaration
Notification CreateNotification(IUser user, IEntity entity, string action)
Parameters
Type |
Name |
Description |
IUser |
user |
|
IEntity |
entity |
|
System.String |
action |
The action letter - note: this is a string for future compatibility
|
Returns
DeleteNotifications(IEntity)
Deletes notifications by entity
Declaration
void DeleteNotifications(IEntity entity)
Parameters
Type |
Name |
Description |
IEntity |
entity |
|
DeleteNotifications(IUser)
Deletes notifications by user
Declaration
void DeleteNotifications(IUser user)
Parameters
Type |
Name |
Description |
IUser |
user |
|
DeleteNotifications(IUser, IEntity)
Delete notifications by user and entity
Declaration
void DeleteNotifications(IUser user, IEntity entity)
Parameters
GetEntityNotifications(IEntity)
Returns the notifications for an entity
Declaration
IEnumerable<Notification> GetEntityNotifications(IEntity entity)
Parameters
Type |
Name |
Description |
IEntity |
entity |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<Notification> |
|
GetUserNotifications(IUser)
Gets the notifications for the user
Declaration
IEnumerable<Notification> GetUserNotifications(IUser user)
Parameters
Type |
Name |
Description |
IUser |
user |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<Notification> |
|
GetUserNotifications(IUser, String)
Gets the notifications for the user based on the specified node path
Declaration
IEnumerable<Notification> GetUserNotifications(IUser user, string path)
Parameters
Type |
Name |
Description |
IUser |
user |
|
System.String |
path |
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<Notification> |
|
SendNotifications(IUser, IEnumerable<IUmbracoEntity>, String, String, HttpContextBase, Func<IUser, String[], String>, Func<IUser, String[], String>)
Sends the notifications for the specified user regarding the specified nodes and action.
Declaration
void SendNotifications(IUser operatingUser, IEnumerable<IUmbracoEntity> entities, string action, string actionName, HttpContextBase http, Func<IUser, string[], string> createSubject, Func<IUser, string[], string> createBody)
Parameters
Type |
Name |
Description |
IUser |
operatingUser |
|
System.Collections.Generic.IEnumerable<IUmbracoEntity> |
entities |
|
System.String |
action |
|
System.String |
actionName |
|
System.Web.HttpContextBase |
http |
|
System.Func<IUser, System.String[], System.String> |
createSubject |
|
System.Func<IUser, System.String[], System.String> |
createBody |
|
SendNotifications(IUser, IUmbracoEntity, String, String, HttpContextBase, Func<IUser, String[], String>, Func<IUser, String[], String>)
Sends the notifications for the specified user regarding the specified node and action.
Declaration
void SendNotifications(IUser operatingUser, IUmbracoEntity entity, string action, string actionName, HttpContextBase http, Func<IUser, string[], string> createSubject, Func<IUser, string[], string> createBody)
Parameters
Type |
Name |
Description |
IUser |
operatingUser |
|
IUmbracoEntity |
entity |
|
System.String |
action |
|
System.String |
actionName |
|
System.Web.HttpContextBase |
http |
|
System.Func<IUser, System.String[], System.String> |
createSubject |
|
System.Func<IUser, System.String[], System.String> |
createBody |
|