diff --git a/src/Umbraco.Core/Notifications/AssignedMemberRolesNotification.cs b/src/Umbraco.Core/Notifications/AssignedMemberRolesNotification.cs index 23438827fd..96d0391b95 100644 --- a/src/Umbraco.Core/Notifications/AssignedMemberRolesNotification.cs +++ b/src/Umbraco.Core/Notifications/AssignedMemberRolesNotification.cs @@ -1,7 +1,18 @@ namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberService when the AssignRoles and ReplaceRoles methods are called in the API. +/// public class AssignedMemberRolesNotification : MemberRolesNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Collection of Ids of the members the roles are being assigned to. + /// + /// + /// Collection of role names being assigned. + /// public AssignedMemberRolesNotification(int[] memberIds, string[] roles) : base(memberIds, roles) { diff --git a/src/Umbraco.Core/Notifications/ContentCacheRefresherNotification.cs b/src/Umbraco.Core/Notifications/ContentCacheRefresherNotification.cs index 67a43b5ac2..b9a6b0c83f 100644 --- a/src/Umbraco.Core/Notifications/ContentCacheRefresherNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentCacheRefresherNotification.cs @@ -2,8 +2,20 @@ using Umbraco.Cms.Core.Sync; namespace Umbraco.Cms.Core.Notifications; +/// +/// A notification that is used to trigger the Content Cache Refresher. +/// public class ContentCacheRefresherNotification : CacheRefresherNotification { + /// + /// Initializes a new instance of the + /// + /// + /// The refresher payload. + /// + /// + /// Type of the cache refresher message, + /// public ContentCacheRefresherNotification(object messageObject, MessageType messageType) : base( messageObject, diff --git a/src/Umbraco.Core/Notifications/ContentCopiedNotification.cs b/src/Umbraco.Core/Notifications/ContentCopiedNotification.cs index 6bf525cbb2..21500caf39 100644 --- a/src/Umbraco.Core/Notifications/ContentCopiedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentCopiedNotification.cs @@ -5,7 +5,10 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the Copy method is called in the API. +/// The notification is published after the content object has been copied. +/// public sealed class ContentCopiedNotification : CopiedNotification { public ContentCopiedNotification(IContent original, IContent copy, int parentId, Guid? parentKey, bool relateToOriginal, EventMessages messages) @@ -13,6 +16,24 @@ public sealed class ContentCopiedNotification : CopiedNotification { } + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the original object. + /// + /// + /// Gets the object being copied. + /// + /// + /// Gets the ID of the parent of the being copied. + /// + /// + /// Boolean indicating whether the copy was related to the orginal. + /// + /// + /// Initializes a new instance of the . + /// [Obsolete("Please use constructor that takes a parent key as well, scheduled for removal in v15")] public ContentCopiedNotification(IContent original, IContent copy, int parentId, bool relateToOriginal, EventMessages messages) : this(original, copy, parentId, null, relateToOriginal, messages) diff --git a/src/Umbraco.Core/Notifications/ContentCopyingNotification.cs b/src/Umbraco.Core/Notifications/ContentCopyingNotification.cs index b905869353..a5106554ca 100644 --- a/src/Umbraco.Core/Notifications/ContentCopyingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentCopyingNotification.cs @@ -5,7 +5,10 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the Copy method is called in the API. +/// The notification is published after a copy object has been created and had its parentId updated and its state has been set to unpublished. +/// public sealed class ContentCopyingNotification : CopyingNotification { public ContentCopyingNotification(IContent original, IContent copy, int parentId, Guid? parentKey, EventMessages messages) @@ -13,6 +16,21 @@ public sealed class ContentCopyingNotification : CopyingNotification { } + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the original object. + /// + /// + /// Gets the object being copied. + /// + /// + /// Gets the ID of the parent of the being copied. + /// + /// + /// Initializes a new instance of the . + /// [Obsolete("Please use constructor that takes a parent key as well, scheduled for removal in v15")] public ContentCopyingNotification(IContent original, IContent copy, int parentId, EventMessages messages) : this(original, copy, parentId, null, messages) diff --git a/src/Umbraco.Core/Notifications/ContentDeletedBlueprintNotification.cs b/src/Umbraco.Core/Notifications/ContentDeletedBlueprintNotification.cs index 884fcf493b..3d9a19177f 100644 --- a/src/Umbraco.Core/Notifications/ContentDeletedBlueprintNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentDeletedBlueprintNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the DeletedBlueprint method is called in the API. +/// public sealed class ContentDeletedBlueprintNotification : EnumerableObjectNotification { public ContentDeletedBlueprintNotification(IContent target, EventMessages messages) @@ -19,6 +21,8 @@ public sealed class ContentDeletedBlueprintNotification : EnumerableObjectNotifi messages) { } - + /// + /// The collection of deleted blueprint IContent. + /// public IEnumerable DeletedBlueprints => Target; } diff --git a/src/Umbraco.Core/Notifications/ContentDeletedNotification.cs b/src/Umbraco.Core/Notifications/ContentDeletedNotification.cs index c68a07b1f0..5bb8838617 100644 --- a/src/Umbraco.Core/Notifications/ContentDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentDeletedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the Delete and EmptyRecycleBin methods are called in the API. +/// public sealed class ContentDeletedNotification : DeletedNotification { public ContentDeletedNotification(IContent target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentDeletedVersionsNotification.cs b/src/Umbraco.Core/Notifications/ContentDeletedVersionsNotification.cs index 5e2b646008..21e4180e65 100644 --- a/src/Umbraco.Core/Notifications/ContentDeletedVersionsNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentDeletedVersionsNotification.cs @@ -5,9 +5,29 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the DeleteVersion and DeleteVersions methods are called in the API, and the version has been deleted. +/// public sealed class ContentDeletedVersionsNotification : DeletedVersionsNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the ID of the object being deleted. + /// + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the id of the IContent object version being deleted. + /// + /// + /// False by default. + /// + /// + /// Gets the latest version date. + /// public ContentDeletedVersionsNotification( int id, EventMessages messages, diff --git a/src/Umbraco.Core/Notifications/ContentDeletingNotification.cs b/src/Umbraco.Core/Notifications/ContentDeletingNotification.cs index de4176a01b..aa929e48d1 100644 --- a/src/Umbraco.Core/Notifications/ContentDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentDeletingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the DeleteContentOfType, Delete and EmptyRecycleBin methods are called in the API. +/// public sealed class ContentDeletingNotification : DeletingNotification { public ContentDeletingNotification(IContent target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentDeletingVersionsNotification.cs b/src/Umbraco.Core/Notifications/ContentDeletingVersionsNotification.cs index 5d173bcc0c..0e620d19d2 100644 --- a/src/Umbraco.Core/Notifications/ContentDeletingVersionsNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentDeletingVersionsNotification.cs @@ -5,9 +5,29 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the DeleteVersion and DeleteVersions methods are called in the API. +/// public sealed class ContentDeletingVersionsNotification : DeletingVersionsNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the ID of the object being deleted. + /// + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the id of the IContent object version being deleted. + /// + /// + /// False by default. + /// + /// + /// Gets the latest version date. + /// public ContentDeletingVersionsNotification(int id, EventMessages messages, int specificVersion = default, bool deletePriorVersions = false, DateTime dateToRetain = default) : base(id, messages, specificVersion, deletePriorVersions, dateToRetain) { diff --git a/src/Umbraco.Core/Notifications/ContentEmptiedRecycleBinNotification.cs b/src/Umbraco.Core/Notifications/ContentEmptiedRecycleBinNotification.cs index 9a1637dda9..6398d5d9c3 100644 --- a/src/Umbraco.Core/Notifications/ContentEmptiedRecycleBinNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentEmptiedRecycleBinNotification.cs @@ -5,9 +5,20 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the EmptyRecycleBin method is called in the API, after the RecycleBin has been deleted. +/// public sealed class ContentEmptiedRecycleBinNotification : EmptiedRecycleBinNotification { + /// + /// Initializes a new instance of the + /// + /// + /// The collection of deleted IContent object. + /// + /// + /// Initializes a new instance of the . + /// public ContentEmptiedRecycleBinNotification(IEnumerable deletedEntities, EventMessages messages) : base( deletedEntities, messages) diff --git a/src/Umbraco.Core/Notifications/ContentEmptyingRecycleBinNotification.cs b/src/Umbraco.Core/Notifications/ContentEmptyingRecycleBinNotification.cs index f55d1166ce..370b027c27 100644 --- a/src/Umbraco.Core/Notifications/ContentEmptyingRecycleBinNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentEmptyingRecycleBinNotification.cs @@ -5,9 +5,20 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the EmptyRecycleBin method is called in the API. +/// public sealed class ContentEmptyingRecycleBinNotification : EmptyingRecycleBinNotification { + /// + /// Initializes a new instance of the + /// + /// + /// The collection of IContent objects being deleted. + /// + /// + /// Initializes a new instance of the . + /// public ContentEmptyingRecycleBinNotification(IEnumerable? deletedEntities, EventMessages messages) : base( deletedEntities, messages) diff --git a/src/Umbraco.Core/Notifications/ContentMovedNotification.cs b/src/Umbraco.Core/Notifications/ContentMovedNotification.cs index bfba84db48..01690155c3 100644 --- a/src/Umbraco.Core/Notifications/ContentMovedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentMovedNotification.cs @@ -7,7 +7,9 @@ using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; /// -/// Called after content has been moved. +/// A notification that is used to trigger the IContentService when the Move method is called in the API. +/// The notification is published and called after the content object has been moved. +/// NOTE: If the target parent is the Recycle bin, this notification is never published. Try the instead. /// public sealed class ContentMovedNotification : MovedNotification { diff --git a/src/Umbraco.Core/Notifications/ContentMovedToRecycleBinNotification.cs b/src/Umbraco.Core/Notifications/ContentMovedToRecycleBinNotification.cs index 6f4a6cea5a..3c71d7bbed 100644 --- a/src/Umbraco.Core/Notifications/ContentMovedToRecycleBinNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentMovedToRecycleBinNotification.cs @@ -5,7 +5,10 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the MoveToRecycleBin method is called in the API. +/// Is published after the content has been moved to the Recycle Bin. +/// public sealed class ContentMovedToRecycleBinNotification : MovedToRecycleBinNotification { public ContentMovedToRecycleBinNotification(MoveToRecycleBinEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentMovingNotification.cs b/src/Umbraco.Core/Notifications/ContentMovingNotification.cs index 6fd0fc1115..9a84e25853 100644 --- a/src/Umbraco.Core/Notifications/ContentMovingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentMovingNotification.cs @@ -7,7 +7,9 @@ using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; /// +/// A notification that is used to trigger the IContentService when the Move method is called in the API. /// Called while content is moving, but before it has been moved. Cancel the operation to prevent the movement. +/// NOTE: If the target parent is the Recycle bin, this notification is never published. Try the instead. /// public sealed class ContentMovingNotification : MovingNotification { diff --git a/src/Umbraco.Core/Notifications/ContentMovingToRecycleBinNotification.cs b/src/Umbraco.Core/Notifications/ContentMovingToRecycleBinNotification.cs index 91ef7dd91c..398b570b6b 100644 --- a/src/Umbraco.Core/Notifications/ContentMovingToRecycleBinNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentMovingToRecycleBinNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the MoveToRecycleBin method is called in the API. +/// public sealed class ContentMovingToRecycleBinNotification : MovingToRecycleBinNotification { public ContentMovingToRecycleBinNotification(MoveToRecycleBinEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentPublishedNotification.cs b/src/Umbraco.Core/Notifications/ContentPublishedNotification.cs index ef911832d2..07baedc473 100644 --- a/src/Umbraco.Core/Notifications/ContentPublishedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentPublishedNotification.cs @@ -7,6 +7,7 @@ using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; /// +/// A notification that is used to trigger the IContentService when the Publish method is called in the API and after data has been published. /// Called after content has been published. /// public sealed class ContentPublishedNotification : EnumerableObjectNotification @@ -23,7 +24,9 @@ public sealed class ContentPublishedNotification : EnumerableObjectNotification< public ContentPublishedNotification(IEnumerable target, EventMessages messages, bool includeDescendants) : base(target, messages) => IncludeDescendants = includeDescendants; - + /// + /// Gets a enumeration of which are being published. + /// public IEnumerable PublishedEntities => Target; public bool IncludeDescendants { get; } diff --git a/src/Umbraco.Core/Notifications/ContentPublishingNotification.cs b/src/Umbraco.Core/Notifications/ContentPublishingNotification.cs index fd958d2341..ddaf019168 100644 --- a/src/Umbraco.Core/Notifications/ContentPublishingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentPublishingNotification.cs @@ -7,6 +7,7 @@ using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; /// +/// A notification that is used to trigger the IContentService when the Publishing method is called in the API. /// Called while publishing content but before content has been published. Cancel the operation to prevent the publish. /// public sealed class ContentPublishingNotification : CancelableEnumerableObjectNotification diff --git a/src/Umbraco.Core/Notifications/ContentRolledBackNotification.cs b/src/Umbraco.Core/Notifications/ContentRolledBackNotification.cs index 50b89e10b8..db2cf1d132 100644 --- a/src/Umbraco.Core/Notifications/ContentRolledBackNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentRolledBackNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the Rollback method is called in the API, after the content has been rolled back. +/// public sealed class ContentRolledBackNotification : RolledBackNotification { public ContentRolledBackNotification(IContent target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentRollingBackNotification.cs b/src/Umbraco.Core/Notifications/ContentRollingBackNotification.cs index 29b864853c..650de660db 100644 --- a/src/Umbraco.Core/Notifications/ContentRollingBackNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentRollingBackNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the Rollback method is called in the API. +/// public sealed class ContentRollingBackNotification : RollingBackNotification { public ContentRollingBackNotification(IContent target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentSavedBlueprintNotification.cs b/src/Umbraco.Core/Notifications/ContentSavedBlueprintNotification.cs index d06f364ed2..9219b89f23 100644 --- a/src/Umbraco.Core/Notifications/ContentSavedBlueprintNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentSavedBlueprintNotification.cs @@ -5,13 +5,17 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the SavedBlueprint method is called in the API. +/// public sealed class ContentSavedBlueprintNotification : ObjectNotification { public ContentSavedBlueprintNotification(IContent target, EventMessages messages) : base(target, messages) { } - + /// + /// Getting the saved blueprint object. + /// public IContent SavedBlueprint => Target; } diff --git a/src/Umbraco.Core/Notifications/ContentSavedNotification.cs b/src/Umbraco.Core/Notifications/ContentSavedNotification.cs index 2d3253117d..886ee44f67 100644 --- a/src/Umbraco.Core/Notifications/ContentSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentSavedNotification.cs @@ -5,14 +5,21 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the Save method is called in the API and after the data has been persisted. +/// public sealed class ContentSavedNotification : SavedNotification { + /// + /// Initializes a new instance of the + /// public ContentSavedNotification(IContent target, EventMessages messages) : base(target, messages) { } - + /// + /// Gets a enumeration of . + /// public ContentSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/ContentSavingNotification.cs b/src/Umbraco.Core/Notifications/ContentSavingNotification.cs index 4a57a10f29..675c2537ec 100644 --- a/src/Umbraco.Core/Notifications/ContentSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentSavingNotification.cs @@ -5,14 +5,21 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the Save method is called in the API. +/// public sealed class ContentSavingNotification : SavingNotification { + /// + /// Initializes a new instance of the + /// public ContentSavingNotification(IContent target, EventMessages messages) : base(target, messages) { } - + /// + /// Gets a enumeration of . + /// public ContentSavingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/ContentSendingToPublishNotification.cs b/src/Umbraco.Core/Notifications/ContentSendingToPublishNotification.cs index 7d5ee26130..3fca739521 100644 --- a/src/Umbraco.Core/Notifications/ContentSendingToPublishNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentSendingToPublishNotification.cs @@ -5,13 +5,17 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the SendToPublication method is called in the API. +/// public sealed class ContentSendingToPublishNotification : CancelableObjectNotification { public ContentSendingToPublishNotification(IContent target, EventMessages messages) : base(target, messages) { } - + /// + /// Getting the IContent object being sent to publish. + /// public IContent Entity => Target; } diff --git a/src/Umbraco.Core/Notifications/ContentSentToPublishNotification.cs b/src/Umbraco.Core/Notifications/ContentSentToPublishNotification.cs index e10b9930e3..22131d06e1 100644 --- a/src/Umbraco.Core/Notifications/ContentSentToPublishNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentSentToPublishNotification.cs @@ -5,13 +5,17 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the SendToPublication method is called in the API, after the entity has been sent to publication. +/// public sealed class ContentSentToPublishNotification : ObjectNotification { public ContentSentToPublishNotification(IContent target, EventMessages messages) : base(target, messages) { } - + /// + /// Getting the IContent object being sent to publish. + /// public IContent Entity => Target; } diff --git a/src/Umbraco.Core/Notifications/ContentTypeChangedNotification.cs b/src/Umbraco.Core/Notifications/ContentTypeChangedNotification.cs index 0456ebc9cf..f9655e32cd 100644 --- a/src/Umbraco.Core/Notifications/ContentTypeChangedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentTypeChangedNotification.cs @@ -3,7 +3,10 @@ using Umbraco.Cms.Core.Models; using Umbraco.Cms.Core.Services.Changes; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a ContentType is saved or deleted, after the transaction has completed. +/// This is mainly used for caching purposes, and generally not recommended. Use and instead. +/// public class ContentTypeChangedNotification : ContentTypeChangeNotification { public ContentTypeChangedNotification(ContentTypeChange target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentTypeDeletedNotification.cs b/src/Umbraco.Core/Notifications/ContentTypeDeletedNotification.cs index 92092d1a57..cdf322537c 100644 --- a/src/Umbraco.Core/Notifications/ContentTypeDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentTypeDeletedNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ContentTypeService when the Delete method is called in the API, after the entities have been deleted. +/// public class ContentTypeDeletedNotification : DeletedNotification { public ContentTypeDeletedNotification(IContentType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentTypeDeletingNotification.cs b/src/Umbraco.Core/Notifications/ContentTypeDeletingNotification.cs index 0313ffcc17..17c6b08134 100644 --- a/src/Umbraco.Core/Notifications/ContentTypeDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentTypeDeletingNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ContentTypeService when the Delete method is called in the API. +/// public class ContentTypeDeletingNotification : DeletingNotification { public ContentTypeDeletingNotification(IContentType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentTypeMovedNotification.cs b/src/Umbraco.Core/Notifications/ContentTypeMovedNotification.cs index 4fab7a67ac..a90a2ffbd3 100644 --- a/src/Umbraco.Core/Notifications/ContentTypeMovedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentTypeMovedNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ContentTypeService when the Move method is called in the API, after the entities have been moved. +/// public class ContentTypeMovedNotification : MovedNotification { public ContentTypeMovedNotification(MoveEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentTypeMovingNotification.cs b/src/Umbraco.Core/Notifications/ContentTypeMovingNotification.cs index 210dcf43f2..df72a4debf 100644 --- a/src/Umbraco.Core/Notifications/ContentTypeMovingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentTypeMovingNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ContentTypeService when the Move method is called in the API. +/// public class ContentTypeMovingNotification : MovingNotification { public ContentTypeMovingNotification(MoveEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentTypeSavedNotification.cs b/src/Umbraco.Core/Notifications/ContentTypeSavedNotification.cs index f5c45c6323..11b6d43a9e 100644 --- a/src/Umbraco.Core/Notifications/ContentTypeSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentTypeSavedNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ContentTypeService when the Save method is called in the API, after the entities have been saved. +/// public class ContentTypeSavedNotification : SavedNotification { public ContentTypeSavedNotification(IContentType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentTypeSavingNotification.cs b/src/Umbraco.Core/Notifications/ContentTypeSavingNotification.cs index 5c1bc5d611..c08821b556 100644 --- a/src/Umbraco.Core/Notifications/ContentTypeSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentTypeSavingNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ContentTypeService when the Save method is called in the API. +/// public class ContentTypeSavingNotification : SavingNotification { public ContentTypeSavingNotification(IContentType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ContentUnpublishedNotification.cs b/src/Umbraco.Core/Notifications/ContentUnpublishedNotification.cs index 2677ef5a08..959f8aaf02 100644 --- a/src/Umbraco.Core/Notifications/ContentUnpublishedNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentUnpublishedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the UnPublish method is called in the API and after data has been unpublished. +/// public sealed class ContentUnpublishedNotification : EnumerableObjectNotification { public ContentUnpublishedNotification(IContent target, EventMessages messages) @@ -17,6 +19,8 @@ public sealed class ContentUnpublishedNotification : EnumerableObjectNotificatio : base(target, messages) { } - + /// + /// Gets a enumeration of which are being unpublished. + /// public IEnumerable UnpublishedEntities => Target; } diff --git a/src/Umbraco.Core/Notifications/ContentUnpublishingNotification.cs b/src/Umbraco.Core/Notifications/ContentUnpublishingNotification.cs index 7fc0717c04..da3a5b25b6 100644 --- a/src/Umbraco.Core/Notifications/ContentUnpublishingNotification.cs +++ b/src/Umbraco.Core/Notifications/ContentUnpublishingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IContentService when the UnPublishing method is called in the API. +/// public sealed class ContentUnpublishingNotification : CancelableEnumerableObjectNotification { public ContentUnpublishingNotification(IContent target, EventMessages messages) @@ -17,6 +19,8 @@ public sealed class ContentUnpublishingNotification : CancelableEnumerableObject : base(target, messages) { } - + /// + /// Gets a enumeration of which are being unpublished. + /// public IEnumerable UnpublishedEntities => Target; } diff --git a/src/Umbraco.Core/Notifications/DataTypeDeletedNotification.cs b/src/Umbraco.Core/Notifications/DataTypeDeletedNotification.cs index 839fa00230..8b7f3486ac 100644 --- a/src/Umbraco.Core/Notifications/DataTypeDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/DataTypeDeletedNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the DataTypeService when the Delete method is called in the API, after the IDataType objects have been deleted. +/// public class DataTypeDeletedNotification : DeletedNotification { public DataTypeDeletedNotification(IDataType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/DataTypeDeletingNotification.cs b/src/Umbraco.Core/Notifications/DataTypeDeletingNotification.cs index 70035a5237..d97632152b 100644 --- a/src/Umbraco.Core/Notifications/DataTypeDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/DataTypeDeletingNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the DataTypeService when the Delete method is called in the API. +/// public class DataTypeDeletingNotification : DeletingNotification { public DataTypeDeletingNotification(IDataType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/DataTypeMovedNotification.cs b/src/Umbraco.Core/Notifications/DataTypeMovedNotification.cs index 27065b8619..50d98213a2 100644 --- a/src/Umbraco.Core/Notifications/DataTypeMovedNotification.cs +++ b/src/Umbraco.Core/Notifications/DataTypeMovedNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the DataTypeService when the Move method is called in the API, after the IDataType has been moved. +/// public class DataTypeMovedNotification : MovedNotification { public DataTypeMovedNotification(MoveEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/DataTypeMovingNotification.cs b/src/Umbraco.Core/Notifications/DataTypeMovingNotification.cs index 1a54f14622..6f1247966c 100644 --- a/src/Umbraco.Core/Notifications/DataTypeMovingNotification.cs +++ b/src/Umbraco.Core/Notifications/DataTypeMovingNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the DataTypeService when the Move method is called in the API. +/// public class DataTypeMovingNotification : MovingNotification { public DataTypeMovingNotification(MoveEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/DataTypeSavedNotification.cs b/src/Umbraco.Core/Notifications/DataTypeSavedNotification.cs index ca23336ce1..58ad7c124c 100644 --- a/src/Umbraco.Core/Notifications/DataTypeSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/DataTypeSavedNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the DataTypeService when the Save method is called in the API, and after data has been persisted. +/// public class DataTypeSavedNotification : SavedNotification { public DataTypeSavedNotification(IDataType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/DataTypeSavingNotification.cs b/src/Umbraco.Core/Notifications/DataTypeSavingNotification.cs index 8099431da6..cb910638ee 100644 --- a/src/Umbraco.Core/Notifications/DataTypeSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/DataTypeSavingNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the DataTypeService when the Save method is called in the API. +/// public class DataTypeSavingNotification : SavingNotification { public DataTypeSavingNotification(IDataType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/DictionaryItemDeletedNotification.cs b/src/Umbraco.Core/Notifications/DictionaryItemDeletedNotification.cs index c62f6d3f7d..8c8d9ada88 100644 --- a/src/Umbraco.Core/Notifications/DictionaryItemDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/DictionaryItemDeletedNotification.cs @@ -5,9 +5,20 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Delete (IDictionaryItem overload) method is called in the API, after the dictionary items has been deleted. +/// public class DictionaryItemDeletedNotification : DeletedNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of the deleted IDictionaryItem objects. + /// + /// + /// Initializes a new instance of the . + /// public DictionaryItemDeletedNotification(IDictionaryItem target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/DictionaryItemDeletingNotification.cs b/src/Umbraco.Core/Notifications/DictionaryItemDeletingNotification.cs index d882bb594f..ed7d40eb47 100644 --- a/src/Umbraco.Core/Notifications/DictionaryItemDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/DictionaryItemDeletingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Delete (IDictionaryItem overload) method is called in the API. +/// public class DictionaryItemDeletingNotification : DeletingNotification { public DictionaryItemDeletingNotification(IDictionaryItem target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of deleted IDictionaryItem objects. + /// + /// + /// Initializes a new instance of the . + /// public DictionaryItemDeletingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/DictionaryItemSavedNotification.cs b/src/Umbraco.Core/Notifications/DictionaryItemSavedNotification.cs index 386871a28b..da4e6687ca 100644 --- a/src/Umbraco.Core/Notifications/DictionaryItemSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/DictionaryItemSavedNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Save (IDictionaryItem overload) method is called in the API and the data has been persisted. +/// public class DictionaryItemSavedNotification : SavedNotification { - public DictionaryItemSavedNotification(IDictionaryItem target, EventMessages messages) + public DictionaryItemSavedNotification(IDictionaryItem target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the + /// + /// + /// Gets the saved collection of IDictionary objects. + /// + /// + /// Initializes a new instance of the . + /// public DictionaryItemSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/DictionaryItemSavingNotification.cs b/src/Umbraco.Core/Notifications/DictionaryItemSavingNotification.cs index 517fc772a0..4766cdddc1 100644 --- a/src/Umbraco.Core/Notifications/DictionaryItemSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/DictionaryItemSavingNotification.cs @@ -5,9 +5,20 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Save (IDictionaryItem overload) method is called in the API. +/// public class DictionaryItemSavingNotification : SavingNotification { + /// + /// Initializes a new instance of the + /// + /// + /// Gets the collection of IDictionaryItem objects being saved. + /// + /// + /// Initializes a new instance of the . + /// public DictionaryItemSavingNotification(IDictionaryItem target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/LanguageDeletedNotification.cs b/src/Umbraco.Core/Notifications/LanguageDeletedNotification.cs index 9f435775aa..61884e1e16 100644 --- a/src/Umbraco.Core/Notifications/LanguageDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/LanguageDeletedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Delete (ILanguage overload) method is called in the API, after the languages have been deleted. +/// public class LanguageDeletedNotification : DeletedNotification { public LanguageDeletedNotification(ILanguage target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/LanguageDeletingNotification.cs b/src/Umbraco.Core/Notifications/LanguageDeletingNotification.cs index 1fdff6538f..7f011beb81 100644 --- a/src/Umbraco.Core/Notifications/LanguageDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/LanguageDeletingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Delete (ILanguage overload) method is called in the API. +/// public class LanguageDeletingNotification : DeletingNotification { public LanguageDeletingNotification(ILanguage target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/LanguageSavedNotification.cs b/src/Umbraco.Core/Notifications/LanguageSavedNotification.cs index b3e58e9b83..15d99a404c 100644 --- a/src/Umbraco.Core/Notifications/LanguageSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/LanguageSavedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Save (ILanguage overload) method is called in the API, after data has been persisted. +/// public class LanguageSavedNotification : SavedNotification { public LanguageSavedNotification(ILanguage target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/LanguageSavingNotification.cs b/src/Umbraco.Core/Notifications/LanguageSavingNotification.cs index adbba95ad4..74370355c6 100644 --- a/src/Umbraco.Core/Notifications/LanguageSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/LanguageSavingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the ILocalizationService when the Save (ILanguage overload) method is called in the API. +/// public class LanguageSavingNotification : SavingNotification { public LanguageSavingNotification(ILanguage target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MediaCacheRefresherNotification.cs b/src/Umbraco.Core/Notifications/MediaCacheRefresherNotification.cs index 9277e20423..fe5c21f9b6 100644 --- a/src/Umbraco.Core/Notifications/MediaCacheRefresherNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaCacheRefresherNotification.cs @@ -1,9 +1,20 @@ using Umbraco.Cms.Core.Sync; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the Media Cache Refresher. +/// public class MediaCacheRefresherNotification : CacheRefresherNotification { + /// + /// Initializes a new instance of the + /// + /// + /// The refresher payload. + /// + /// + /// Type of the cache refresher message, + /// public MediaCacheRefresherNotification(object messageObject, MessageType messageType) : base(messageObject, messageType) { diff --git a/src/Umbraco.Core/Notifications/MediaDeletedNotification.cs b/src/Umbraco.Core/Notifications/MediaDeletedNotification.cs index 643f907ab8..1ee19432c9 100644 --- a/src/Umbraco.Core/Notifications/MediaDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaDeletedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the Delete and EmptyRecycleBin methods are called in the API, after the media has been deleted. +/// public sealed class MediaDeletedNotification : DeletedNotification { public MediaDeletedNotification(IMedia target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MediaDeletedVersionsNotification.cs b/src/Umbraco.Core/Notifications/MediaDeletedVersionsNotification.cs index b8520e5274..f6ab5c0c88 100644 --- a/src/Umbraco.Core/Notifications/MediaDeletedVersionsNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaDeletedVersionsNotification.cs @@ -5,9 +5,29 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the DeleteVersion and DeleteVersions methods are called in the API, after the media version has been deleted. +/// public sealed class MediaDeletedVersionsNotification : DeletedVersionsNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the id of the deleted object. + /// + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the id of the deleted object version. + /// + /// + /// False by default. + /// + /// + /// Gets the latest version date. + /// public MediaDeletedVersionsNotification(int id, EventMessages messages, int specificVersion = default, bool deletePriorVersions = false, DateTime dateToRetain = default) : base(id, messages, specificVersion, deletePriorVersions, dateToRetain) { diff --git a/src/Umbraco.Core/Notifications/MediaDeletingNotification.cs b/src/Umbraco.Core/Notifications/MediaDeletingNotification.cs index 8973b9861f..5de8242d98 100644 --- a/src/Umbraco.Core/Notifications/MediaDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaDeletingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the DeleteMediaOfType, Delete and EmptyRecycleBin methods are called in the API. +/// public sealed class MediaDeletingNotification : DeletingNotification { public MediaDeletingNotification(IMedia target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being deleted. + /// + /// + /// Initializes a new instance of the . + /// public MediaDeletingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaDeletingVersionsNotification.cs b/src/Umbraco.Core/Notifications/MediaDeletingVersionsNotification.cs index 0d7ff01ca3..a8a9b739e0 100644 --- a/src/Umbraco.Core/Notifications/MediaDeletingVersionsNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaDeletingVersionsNotification.cs @@ -5,9 +5,29 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the DeleteVersion and DeleteVersions methods are called in the API. +/// public sealed class MediaDeletingVersionsNotification : DeletingVersionsNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the id of the object being deleted. + /// + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the id of the object version being deleted. + /// + /// + /// False by default. + /// + /// + /// Gets the latest version date. + /// public MediaDeletingVersionsNotification(int id, EventMessages messages, int specificVersion = default, bool deletePriorVersions = false, DateTime dateToRetain = default) : base(id, messages, specificVersion, deletePriorVersions, dateToRetain) { diff --git a/src/Umbraco.Core/Notifications/MediaMovedNotification.cs b/src/Umbraco.Core/Notifications/MediaMovedNotification.cs index d7cf614ed9..3ef46323ed 100644 --- a/src/Umbraco.Core/Notifications/MediaMovedNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaMovedNotification.cs @@ -5,7 +5,10 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the Move method is called in the API. The event is fired after the media object has been moved. +/// NOTE: If the target parent is the Recycle bin, this notification is never published. Try the instead. +/// public sealed class MediaMovedNotification : MovedNotification { public MediaMovedNotification(MoveEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MediaMovedToRecycleBinNotification.cs b/src/Umbraco.Core/Notifications/MediaMovedToRecycleBinNotification.cs index c84fa73d50..57897587b8 100644 --- a/src/Umbraco.Core/Notifications/MediaMovedToRecycleBinNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaMovedToRecycleBinNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the MoveToRecycleBin method is called in the API, after the media object has been moved to the RecycleBin. +/// public sealed class MediaMovedToRecycleBinNotification : MovedToRecycleBinNotification { public MediaMovedToRecycleBinNotification(MoveToRecycleBinEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MediaMovingNotification.cs b/src/Umbraco.Core/Notifications/MediaMovingNotification.cs index c1f5a7ab94..a4c906b265 100644 --- a/src/Umbraco.Core/Notifications/MediaMovingNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaMovingNotification.cs @@ -5,7 +5,10 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the Move method is called in the API. +/// NOTE: If the target parent is the Recycle bin, this notification is never published. Try the instead. +/// public sealed class MediaMovingNotification : MovingNotification { public MediaMovingNotification(MoveEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MediaMovingToRecycleBinNotification.cs b/src/Umbraco.Core/Notifications/MediaMovingToRecycleBinNotification.cs index a88484d150..2baad45ef3 100644 --- a/src/Umbraco.Core/Notifications/MediaMovingToRecycleBinNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaMovingToRecycleBinNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the MoveToRecycleBin method is called in the API. +/// public sealed class MediaMovingToRecycleBinNotification : MovingToRecycleBinNotification { public MediaMovingToRecycleBinNotification(MoveToRecycleBinEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MediaSavedNotification.cs b/src/Umbraco.Core/Notifications/MediaSavedNotification.cs index bf9f507521..1f804ae5df 100644 --- a/src/Umbraco.Core/Notifications/MediaSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaSavedNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the Save method is called in the API and after the data has been persisted. +/// public sealed class MediaSavedNotification : SavedNotification { public MediaSavedNotification(IMedia target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the saved collection of objects. + /// + /// + /// Initializes a new instance of the . + /// public MediaSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaSavingNotification.cs b/src/Umbraco.Core/Notifications/MediaSavingNotification.cs index d902de6ba7..c520266832 100644 --- a/src/Umbraco.Core/Notifications/MediaSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaSavingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaService when the Save method is called in the API. +/// public sealed class MediaSavingNotification : SavingNotification { public MediaSavingNotification(IMedia target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being saved. + /// + /// + /// Initializes a new instance of the . + /// public MediaSavingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaTypeChangedNotification.cs b/src/Umbraco.Core/Notifications/MediaTypeChangedNotification.cs index 1882c7cc74..5410d84bfb 100644 --- a/src/Umbraco.Core/Notifications/MediaTypeChangedNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaTypeChangedNotification.cs @@ -3,7 +3,9 @@ using Umbraco.Cms.Core.Models; using Umbraco.Cms.Core.Services.Changes; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a MediaType is saved or deleted, after the transaction has completed. This is mainly used for caching purposes, and generally not recommended. Use and instead. +/// public class MediaTypeChangedNotification : ContentTypeChangeNotification { public MediaTypeChangedNotification(ContentTypeChange target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MediaTypeDeletedNotification.cs b/src/Umbraco.Core/Notifications/MediaTypeDeletedNotification.cs index 8ad8e1bce5..c100867ffd 100644 --- a/src/Umbraco.Core/Notifications/MediaTypeDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaTypeDeletedNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaTypeService when the Delete method is called in the API, after the entities has been deleted. +/// public class MediaTypeDeletedNotification : DeletedNotification { public MediaTypeDeletedNotification(IMediaType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of deleted objects. + /// + /// + /// Initializes a new instance of the . + /// public MediaTypeDeletedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaTypeDeletingNotification.cs b/src/Umbraco.Core/Notifications/MediaTypeDeletingNotification.cs index a819ef0d8c..2ee54d3083 100644 --- a/src/Umbraco.Core/Notifications/MediaTypeDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaTypeDeletingNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaTypeService when the Delete method is called in the API. +/// public class MediaTypeDeletingNotification : DeletingNotification { public MediaTypeDeletingNotification(IMediaType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being deleted. + /// + /// + /// Initializes a new instance of the . + /// public MediaTypeDeletingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaTypeMovedNotification.cs b/src/Umbraco.Core/Notifications/MediaTypeMovedNotification.cs index f05d5fd37b..c005602dd8 100644 --- a/src/Umbraco.Core/Notifications/MediaTypeMovedNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaTypeMovedNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaTypeService when the Move method is called in the API, after the entities has been moved. +/// public class MediaTypeMovedNotification : MovedNotification { public MediaTypeMovedNotification(MoveEventInfo target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the object being moved. + /// + /// + /// Initializes a new instance of the . + /// public MediaTypeMovedNotification(IEnumerable> target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaTypeMovingNotification.cs b/src/Umbraco.Core/Notifications/MediaTypeMovingNotification.cs index 9b7ac27c13..5cdad939ec 100644 --- a/src/Umbraco.Core/Notifications/MediaTypeMovingNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaTypeMovingNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaTypeService when the Move method is called in the API. +/// public class MediaTypeMovingNotification : MovingNotification { public MediaTypeMovingNotification(MoveEventInfo target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the object being moved. + /// + /// + /// Initializes a new instance of the . + /// public MediaTypeMovingNotification(IEnumerable> target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaTypeSavedNotification.cs b/src/Umbraco.Core/Notifications/MediaTypeSavedNotification.cs index 17063f5252..092814e89e 100644 --- a/src/Umbraco.Core/Notifications/MediaTypeSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaTypeSavedNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaTypeService when the Save method is called in the API, after the entities has been saved. +/// public class MediaTypeSavedNotification : SavedNotification { public MediaTypeSavedNotification(IMediaType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of saved objects. + /// + /// + /// Initializes a new instance of the . + /// public MediaTypeSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MediaTypeSavingNotification.cs b/src/Umbraco.Core/Notifications/MediaTypeSavingNotification.cs index 46bc588b39..66ab97df25 100644 --- a/src/Umbraco.Core/Notifications/MediaTypeSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/MediaTypeSavingNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMediaTypeService when the Save method is called in the API. +/// public class MediaTypeSavingNotification : SavingNotification { public MediaTypeSavingNotification(IMediaType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being saved. + /// + /// + /// Initializes a new instance of the . + /// public MediaTypeSavingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberCacheRefresherNotification.cs b/src/Umbraco.Core/Notifications/MemberCacheRefresherNotification.cs index 46101878aa..a765bcb1db 100644 --- a/src/Umbraco.Core/Notifications/MemberCacheRefresherNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberCacheRefresherNotification.cs @@ -1,9 +1,20 @@ using Umbraco.Cms.Core.Sync; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the Member Cache Refresher. +/// public class MemberCacheRefresherNotification : CacheRefresherNotification { + /// + /// Initializes a new instance of the + /// + /// + /// The refresher payload. + /// + /// + /// Type of the cache refresher message, + /// public MemberCacheRefresherNotification(object messageObject, MessageType messageType) : base(messageObject, messageType) { diff --git a/src/Umbraco.Core/Notifications/MemberDeletedNotification.cs b/src/Umbraco.Core/Notifications/MemberDeletedNotification.cs index b1578fd998..ba3c84ba40 100644 --- a/src/Umbraco.Core/Notifications/MemberDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberDeletedNotification.cs @@ -5,9 +5,20 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberService when the Delete and DeleteMembersOfType methods are called in the API, after the members have been deleted. +/// public sealed class MemberDeletedNotification : DeletedNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of deleted objects. + /// + /// + /// Initializes a new instance of the . + /// public MemberDeletedNotification(IMember target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberDeletingNotification.cs b/src/Umbraco.Core/Notifications/MemberDeletingNotification.cs index df599d7b08..c06912f1b2 100644 --- a/src/Umbraco.Core/Notifications/MemberDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberDeletingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberService when the Delete and DeleteMembersOfType methods are called in the API. +/// public sealed class MemberDeletingNotification : DeletingNotification { public MemberDeletingNotification(IMember target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being deleted. + /// + /// + /// Initializes a new instance of the . + /// public MemberDeletingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberSavedNotification.cs b/src/Umbraco.Core/Notifications/MemberSavedNotification.cs index f59f41f0ec..9bc6097ca2 100644 --- a/src/Umbraco.Core/Notifications/MemberSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberSavedNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberService when the Save method is called in the API and after data has been persisted. +/// public sealed class MemberSavedNotification : SavedNotification { public MemberSavedNotification(IMember target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the saved collection of objects. + /// + /// + /// Initializes a new instance of the . + /// public MemberSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberSavingNotification.cs b/src/Umbraco.Core/Notifications/MemberSavingNotification.cs index 813e6f7269..7f112eef98 100644 --- a/src/Umbraco.Core/Notifications/MemberSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberSavingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberService when the Saving method is called in the API. +/// public sealed class MemberSavingNotification : SavingNotification { public MemberSavingNotification(IMember target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being saved. + /// + /// + /// Initializes a new instance of the . + /// public MemberSavingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberTypeChangedNotification.cs b/src/Umbraco.Core/Notifications/MemberTypeChangedNotification.cs index cbce239394..ceaf15d166 100644 --- a/src/Umbraco.Core/Notifications/MemberTypeChangedNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberTypeChangedNotification.cs @@ -3,7 +3,10 @@ using Umbraco.Cms.Core.Models; using Umbraco.Cms.Core.Services.Changes; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a MemberType is saved or deleted, after the transaction has completed. +/// This is mainly used for caching purposes, and generally not recommended. Use and instead. +/// public class MemberTypeChangedNotification : ContentTypeChangeNotification { public MemberTypeChangedNotification(ContentTypeChange target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MemberTypeDeletedNotification.cs b/src/Umbraco.Core/Notifications/MemberTypeDeletedNotification.cs index b3061cc074..e285fa99c2 100644 --- a/src/Umbraco.Core/Notifications/MemberTypeDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberTypeDeletedNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberTypeService when the Delete method is called in the API, after the entities have been deleted. +/// public class MemberTypeDeletedNotification : DeletedNotification { public MemberTypeDeletedNotification(IMemberType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of deleted objects. + /// + /// + /// Initializes a new instance of the . + /// public MemberTypeDeletedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberTypeDeletingNotification.cs b/src/Umbraco.Core/Notifications/MemberTypeDeletingNotification.cs index d80fcd1c16..d120e30a01 100644 --- a/src/Umbraco.Core/Notifications/MemberTypeDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberTypeDeletingNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberTypeService when the Delete method is called in the API. +/// public class MemberTypeDeletingNotification : DeletingNotification { public MemberTypeDeletingNotification(IMemberType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being deleted. + /// + /// + /// Initializes a new instance of the . + /// public MemberTypeDeletingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberTypeMovingNotification.cs b/src/Umbraco.Core/Notifications/MemberTypeMovingNotification.cs index 9b4445c171..ce2f71badf 100644 --- a/src/Umbraco.Core/Notifications/MemberTypeMovingNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberTypeMovingNotification.cs @@ -2,7 +2,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberTypeService when the Move method is called in the API. +/// public class MemberTypeMovingNotification : MovingNotification { public MemberTypeMovingNotification(MoveEventInfo target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/MemberTypeSavedNotification.cs b/src/Umbraco.Core/Notifications/MemberTypeSavedNotification.cs index 3101c794e2..e68cb3031b 100644 --- a/src/Umbraco.Core/Notifications/MemberTypeSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberTypeSavedNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberTypeService when the Save method is called in the API, after the entities have been saved. +/// public class MemberTypeSavedNotification : SavedNotification { public MemberTypeSavedNotification(IMemberType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of saved objects. + /// + /// + /// Initializes a new instance of the . + /// public MemberTypeSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/MemberTypeSavingNotification.cs b/src/Umbraco.Core/Notifications/MemberTypeSavingNotification.cs index 7cfcb12b91..774adb3ef8 100644 --- a/src/Umbraco.Core/Notifications/MemberTypeSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/MemberTypeSavingNotification.cs @@ -2,14 +2,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberTypeService when the Save method is called in the API. +/// public class MemberTypeSavingNotification : SavingNotification { public MemberTypeSavingNotification(IMemberType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being saved. + /// + /// + /// Initializes a new instance of the . + /// public MemberTypeSavingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RelationDeletedNotification.cs b/src/Umbraco.Core/Notifications/RelationDeletedNotification.cs index 2d93e077c5..e459c3e5f2 100644 --- a/src/Umbraco.Core/Notifications/RelationDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationDeletedNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation has been deleted. +/// public class RelationDeletedNotification : DeletedNotification { public RelationDeletedNotification(IRelation target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects having been deleted. + /// + /// + /// Initializes a new instance of the . + /// public RelationDeletedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RelationDeletingNotification.cs b/src/Umbraco.Core/Notifications/RelationDeletingNotification.cs index 54b49afb54..06902cbb4b 100644 --- a/src/Umbraco.Core/Notifications/RelationDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationDeletingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation is being deleted. +/// public class RelationDeletingNotification : DeletingNotification { public RelationDeletingNotification(IRelation target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being deleted. + /// + /// + /// Initializes a new instance of the . + /// public RelationDeletingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RelationSavedNotification.cs b/src/Umbraco.Core/Notifications/RelationSavedNotification.cs index 3a0b4d9ec8..dd3cb4ca47 100644 --- a/src/Umbraco.Core/Notifications/RelationSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationSavedNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation has been saved. +/// public class RelationSavedNotification : SavedNotification { public RelationSavedNotification(IRelation target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects having been saved. + /// + /// + /// Initializes a new instance of the . + /// public RelationSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RelationSavingNotification.cs b/src/Umbraco.Core/Notifications/RelationSavingNotification.cs index 069e0d5fdc..7da3b971e8 100644 --- a/src/Umbraco.Core/Notifications/RelationSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationSavingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation is being saved. +/// public class RelationSavingNotification : SavingNotification { public RelationSavingNotification(IRelation target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being saved. + /// + /// + /// Initializes a new instance of the . + /// public RelationSavingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RelationTypeDeletedNotification.cs b/src/Umbraco.Core/Notifications/RelationTypeDeletedNotification.cs index 498a4c4370..467d6295b9 100644 --- a/src/Umbraco.Core/Notifications/RelationTypeDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationTypeDeletedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation type has been deleted. +/// public class RelationTypeDeletedNotification : DeletedNotification { public RelationTypeDeletedNotification(IRelationType target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/RelationTypeDeletingNotification.cs b/src/Umbraco.Core/Notifications/RelationTypeDeletingNotification.cs index d9ba61b2b5..25f8049df3 100644 --- a/src/Umbraco.Core/Notifications/RelationTypeDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationTypeDeletingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation type is being deleted. +/// public class RelationTypeDeletingNotification : DeletingNotification { public RelationTypeDeletingNotification(IRelationType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being deleted. + /// + /// + /// Initializes a new instance of the . + /// public RelationTypeDeletingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RelationTypeSavedNotification.cs b/src/Umbraco.Core/Notifications/RelationTypeSavedNotification.cs index d0a1aaf16e..f57c02b900 100644 --- a/src/Umbraco.Core/Notifications/RelationTypeSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationTypeSavedNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation type has been saved. +/// public class RelationTypeSavedNotification : SavedNotification { public RelationTypeSavedNotification(IRelationType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects having been saved. + /// + /// + /// Initializes a new instance of the . + /// public RelationTypeSavedNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RelationTypeSavingNotification.cs b/src/Umbraco.Core/Notifications/RelationTypeSavingNotification.cs index e2f7979e86..148deb200f 100644 --- a/src/Umbraco.Core/Notifications/RelationTypeSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/RelationTypeSavingNotification.cs @@ -5,14 +5,24 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is published when a relation type is being saved. +/// public class RelationTypeSavingNotification : SavingNotification { public RelationTypeSavingNotification(IRelationType target, EventMessages messages) : base(target, messages) { } - + /// + /// Initializes a new instance of the . + /// + /// + /// Gets the collection of objects being saved. + /// + /// + /// Initializes a new instance of the . + /// public RelationTypeSavingNotification(IEnumerable target, EventMessages messages) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/RemovedMemberRolesNotification.cs b/src/Umbraco.Core/Notifications/RemovedMemberRolesNotification.cs index 4ae0a720f7..1b946b1a39 100644 --- a/src/Umbraco.Core/Notifications/RemovedMemberRolesNotification.cs +++ b/src/Umbraco.Core/Notifications/RemovedMemberRolesNotification.cs @@ -1,7 +1,18 @@ namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IMemberService when the DissociateRoles method is called in the API. +/// public class RemovedMemberRolesNotification : MemberRolesNotification { + /// + /// Initializes a new instance of the . + /// + /// + /// Collection of Ids of the members the roles are being removed from. + /// + /// + /// Collection of role names being removed. + /// public RemovedMemberRolesNotification(int[] memberIds, string[] roles) : base(memberIds, roles) { diff --git a/src/Umbraco.Core/Notifications/ScriptDeletedNotification.cs b/src/Umbraco.Core/Notifications/ScriptDeletedNotification.cs index 3ca5f1dc42..9dea26abfd 100644 --- a/src/Umbraco.Core/Notifications/ScriptDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/ScriptDeletedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the DeleteScript method is called in the API, after the script has been deleted. +/// public class ScriptDeletedNotification : DeletedNotification { public ScriptDeletedNotification(IScript target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ScriptDeletingNotification.cs b/src/Umbraco.Core/Notifications/ScriptDeletingNotification.cs index 946dc7f750..abab6ad915 100644 --- a/src/Umbraco.Core/Notifications/ScriptDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/ScriptDeletingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the DeleteScript method is called in the API. +/// public class ScriptDeletingNotification : DeletingNotification { public ScriptDeletingNotification(IScript target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ScriptSavedNotification.cs b/src/Umbraco.Core/Notifications/ScriptSavedNotification.cs index 2a292383e9..ee4f488a6a 100644 --- a/src/Umbraco.Core/Notifications/ScriptSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/ScriptSavedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the SaveScript method is called in the API, after the script has been saved. +/// public class ScriptSavedNotification : SavedNotification { public ScriptSavedNotification(IScript target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/ScriptSavingNotification.cs b/src/Umbraco.Core/Notifications/ScriptSavingNotification.cs index 3ab2b13ce4..c812cd094d 100644 --- a/src/Umbraco.Core/Notifications/ScriptSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/ScriptSavingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the SaveScript method is called in the API. +/// public class ScriptSavingNotification : SavingNotification { public ScriptSavingNotification(IScript target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/StylesheetDeletedNotification.cs b/src/Umbraco.Core/Notifications/StylesheetDeletedNotification.cs index 4b359d60ec..de6b57c7b3 100644 --- a/src/Umbraco.Core/Notifications/StylesheetDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/StylesheetDeletedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the DeleteStylesheet method is called in the API, after the stylesheet has been deleted. +/// public class StylesheetDeletedNotification : DeletedNotification { public StylesheetDeletedNotification(IStylesheet target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/StylesheetDeletingNotification.cs b/src/Umbraco.Core/Notifications/StylesheetDeletingNotification.cs index 8689363577..38b58e380b 100644 --- a/src/Umbraco.Core/Notifications/StylesheetDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/StylesheetDeletingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the DeleteStylesheet method is called in the API. +/// public class StylesheetDeletingNotification : DeletingNotification { public StylesheetDeletingNotification(IStylesheet target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/StylesheetSavedNotification.cs b/src/Umbraco.Core/Notifications/StylesheetSavedNotification.cs index 2f12bebe15..6d5ed9d471 100644 --- a/src/Umbraco.Core/Notifications/StylesheetSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/StylesheetSavedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the SaveStyleSheet method is called in the API, after the script has been saved. +/// public class StylesheetSavedNotification : SavedNotification { public StylesheetSavedNotification(IStylesheet target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/StylesheetSavingNotification.cs b/src/Umbraco.Core/Notifications/StylesheetSavingNotification.cs index 0d6804a76c..f2b0171251 100644 --- a/src/Umbraco.Core/Notifications/StylesheetSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/StylesheetSavingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the SaveStyleSheet method is called in the API. +/// public class StylesheetSavingNotification : SavingNotification { public StylesheetSavingNotification(IStylesheet target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/TemplateDeletedNotification.cs b/src/Umbraco.Core/Notifications/TemplateDeletedNotification.cs index 1bab7d2dc5..919cdb1157 100644 --- a/src/Umbraco.Core/Notifications/TemplateDeletedNotification.cs +++ b/src/Umbraco.Core/Notifications/TemplateDeletedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the DeleteTemplate method is called in the API, after the template has been deleted. +/// public class TemplateDeletedNotification : DeletedNotification { public TemplateDeletedNotification(ITemplate target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/TemplateDeletingNotification.cs b/src/Umbraco.Core/Notifications/TemplateDeletingNotification.cs index 791f43d116..406a049173 100644 --- a/src/Umbraco.Core/Notifications/TemplateDeletingNotification.cs +++ b/src/Umbraco.Core/Notifications/TemplateDeletingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the DeleteTemplate method is called in the API. +/// public class TemplateDeletingNotification : DeletingNotification { public TemplateDeletingNotification(ITemplate target, EventMessages messages) diff --git a/src/Umbraco.Core/Notifications/TemplateSavedNotification.cs b/src/Umbraco.Core/Notifications/TemplateSavedNotification.cs index 8b51e795d4..905c99efb9 100644 --- a/src/Umbraco.Core/Notifications/TemplateSavedNotification.cs +++ b/src/Umbraco.Core/Notifications/TemplateSavedNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the SaveTemplate method is called in the API, after the template has been saved. +/// public class TemplateSavedNotification : SavedNotification { private const string TemplateForContentTypeKey = "CreateTemplateForContentType"; diff --git a/src/Umbraco.Core/Notifications/TemplateSavingNotification.cs b/src/Umbraco.Core/Notifications/TemplateSavingNotification.cs index 45a325feed..bc8aa577ce 100644 --- a/src/Umbraco.Core/Notifications/TemplateSavingNotification.cs +++ b/src/Umbraco.Core/Notifications/TemplateSavingNotification.cs @@ -5,7 +5,9 @@ using Umbraco.Cms.Core.Events; using Umbraco.Cms.Core.Models; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the IFileService when the SaveTemplate method is called in the API. +/// public class TemplateSavingNotification : SavingNotification { private const string TemplateForContentTypeKey = "CreateTemplateForContentType"; @@ -20,7 +22,21 @@ public class TemplateSavingNotification : SavingNotification : base(target, messages) { } - + /// + /// Initializes a new instance of the + /// + /// + /// Initializes a new instance of the . + /// + /// + /// Initializes a new instance of the . + /// + /// + /// Boolean value determining if the template is created for a Document Type. It's not recommended to change this value. + /// + /// + /// This is the alias of the ContentType the template is for. This is used when creating a Document Type with Template. It's not recommended to try and change or set this. + /// public TemplateSavingNotification(ITemplate target, EventMessages messages, bool createTemplateForContentType, string contentTypeAlias) : base(target, messages) { @@ -28,6 +44,21 @@ public class TemplateSavingNotification : SavingNotification ContentTypeAlias = contentTypeAlias; } + /// + /// Initializes a new instance of the + /// + /// + /// Gets a enumeration of the . + /// + /// + /// Initializes a new instance of the . + /// + /// + /// Boolean value determining if the template is created for a Document Type. It's not recommended to change this value. + /// + /// + /// This is the alias of the ContentType the template is for. This is used when creating a Document Type with Template. It's not recommended to try and change or set this. + /// public TemplateSavingNotification(IEnumerable target, EventMessages messages, bool createTemplateForContentType, string contentTypeAlias) : base(target, messages) { diff --git a/src/Umbraco.Core/Notifications/UserCacheRefresherNotification.cs b/src/Umbraco.Core/Notifications/UserCacheRefresherNotification.cs index 589a2df682..81003d1eb3 100644 --- a/src/Umbraco.Core/Notifications/UserCacheRefresherNotification.cs +++ b/src/Umbraco.Core/Notifications/UserCacheRefresherNotification.cs @@ -1,9 +1,20 @@ -using Umbraco.Cms.Core.Sync; +using Umbraco.Cms.Core.Sync; namespace Umbraco.Cms.Core.Notifications; - +/// +/// A notification that is used to trigger the User Cache Refresher. +/// public class UserCacheRefresherNotification : CacheRefresherNotification { + /// + /// Initializes a new instance of the + /// + /// + /// The refresher payload. + /// + /// + /// Type of the cache refresher message, + /// public UserCacheRefresherNotification(object messageObject, MessageType messageType) : base(messageObject, messageType) {