Interface INotificationService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface INotificationService : IService

Methods

View Source

DeleteNotifications(IEntity)

Deletes notifications by entity

Declaration

void DeleteNotifications(IEntity entity)

Parameters

Type	Name	Description
IEntity	entity

View Source

DeleteNotifications(IUser)

Deletes notifications by user

Declaration

void DeleteNotifications(IUser user)

Parameters

Type	Name	Description
IUser	user

View Source

DeleteNotifications(IUser, IEntity)

Delete notifications by user and entity

Declaration

void DeleteNotifications(IUser user, IEntity entity)

Parameters

Type	Name	Description
IUser	user
IEntity	entity

View Source

GetEntityNotifications(IEntity)

Returns the notifications for an entity

Declaration

IEnumerable<Notification>? GetEntityNotifications(IEntity entity)

Parameters

Type	Name	Description
IEntity	entity

Returns

Type	Description
IEnumerable<Notification>

View Source

GetUserNotifications(IUser)

Gets the notifications for the user

Declaration

IEnumerable<Notification>? GetUserNotifications(IUser user)

Parameters

Type	Name	Description
IUser	user

Returns

Type	Description
IEnumerable<Notification>

View Source

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
string	path

Returns

Type	Description
IEnumerable<Notification>

Remarks

Notifications are inherited from the parent so any child node will also have notifications assigned based on it's parent (ancestors)

View Source

SendNotifications(IUser, IEnumerable<IContent>, string?, string?, Uri, Func<(IUser user, NotificationEmailSubjectParams subject), string>, Func<(IUser user, NotificationEmailBodyParams body, bool isHtml), string>)

Sends the notifications for the specified user regarding the specified nodes and action.

Declaration

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)

Parameters

Type	Name	Description
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

View Source

SetNotifications(IUser?, IEntity, string[])

Sets the specific notifications for the user and entity

Declaration

IEnumerable<Notification>? SetNotifications(IUser? user, IEntity entity, string[] actions)

Parameters

Type	Name	Description
IUser	user
IEntity	entity
string[]	actions

Returns

Type	Description
IEnumerable<Notification>

Remarks

This performs a full replace

View Source

TryCreateNotification(IUser, IEntity, string, out Notification?)

Tries to create a new notification.

Declaration

bool TryCreateNotification(IUser user, IEntity entity, string action, out Notification? notification)

Parameters

Type	Name	Description
IUser	user	The user.
IEntity	entity	The entity.
string	action	The action letter - note: this is a string for future compatibility
Notification	notification	The created notification.

Returns

Type	Description
bool