Skip to content

Commit 8574759

Browse files
authored
Update v14 api docs with info from umbraco docs (#15977)
* update api docs * small update
1 parent 513f39f commit 8574759

File tree

98 files changed

+790
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+790
-131
lines changed

src/Umbraco.Core/Notifications/AssignedMemberRolesNotification.cs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
namespace Umbraco.Cms.Core.Notifications;
2-
2+
/// <summary>
3+
/// A notification that is used to trigger the IMemberService when the AssignRoles and ReplaceRoles methods are called in the API.
4+
/// </summary>
35
public class AssignedMemberRolesNotification : MemberRolesNotification
46
{
7+
/// <summary>
8+
/// Initializes a new instance of the <see cref="AssignedMemberRolesNotification"/>.
9+
/// </summary>
10+
/// <param name="memberIds">
11+
/// Collection of Ids of the members the roles are being assigned to.
12+
/// </param>
13+
/// <param name="roles">
14+
/// Collection of role names being assigned.
15+
/// </param>
516
public AssignedMemberRolesNotification(int[] memberIds, string[] roles)
617
: base(memberIds, roles)
718
{

src/Umbraco.Core/Notifications/ContentCacheRefresherNotification.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,20 @@
22

33
namespace Umbraco.Cms.Core.Notifications;
44

5+
/// <summary>
6+
/// A notification that is used to trigger the Content Cache Refresher.
7+
/// </summary>
58
public class ContentCacheRefresherNotification : CacheRefresherNotification
69
{
10+
/// <summary>
11+
/// Initializes a new instance of the <see cref="ContentCacheRefresherNotification"/>
12+
/// </summary>
13+
/// <param name="messageObject">
14+
/// The refresher payload.
15+
/// </param>
16+
/// <param name="messageType">
17+
/// Type of the cache refresher message, <see cref="MessageType"/>
18+
/// </param>
719
public ContentCacheRefresherNotification(object messageObject, MessageType messageType)
820
: base(
921
messageObject,

src/Umbraco.Core/Notifications/ContentCopiedNotification.cs

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,35 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// A notification that is used to trigger the IContentService when the Copy method is called in the API.
10+
/// The notification is published after the content object has been copied.
11+
/// </summary>
912
public sealed class ContentCopiedNotification : CopiedNotification<IContent>
1013
{
1114
public ContentCopiedNotification(IContent original, IContent copy, int parentId, Guid? parentKey, bool relateToOriginal, EventMessages messages)
1215
: base(original, copy, parentId, parentKey, relateToOriginal, messages)
1316
{
1417
}
1518

19+
/// <summary>
20+
/// Initializes a new instance of the <see cref="ContentCopiedNotification"/>.
21+
/// </summary>
22+
/// <param name="original">
23+
/// Gets the original <see cref="IContent"/> object.
24+
/// </param>
25+
/// <param name="copy">
26+
/// Gets the <see cref="IContent"/> object being copied.
27+
/// </param>
28+
/// <param name="parentId">
29+
/// Gets the ID of the parent of the <see cref="IContent"/> being copied.
30+
/// </param>
31+
/// <param name="relateToOriginal">
32+
/// Boolean indicating whether the copy was related to the orginal.
33+
/// </param>
34+
/// <param name="messages">
35+
/// Initializes a new instance of the <see cref="EventMessages"/>.
36+
/// </param>
1637
[Obsolete("Please use constructor that takes a parent key as well, scheduled for removal in v15")]
1738
public ContentCopiedNotification(IContent original, IContent copy, int parentId, bool relateToOriginal, EventMessages messages)
1839
: this(original, copy, parentId, null, relateToOriginal, messages)

src/Umbraco.Core/Notifications/ContentCopyingNotification.cs

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,32 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// A notification that is used to trigger the IContentService when the Copy method is called in the API.
10+
/// The notification is published after a copy object has been created and had its parentId updated and its state has been set to unpublished.
11+
/// </summary>
912
public sealed class ContentCopyingNotification : CopyingNotification<IContent>
1013
{
1114
public ContentCopyingNotification(IContent original, IContent copy, int parentId, Guid? parentKey, EventMessages messages)
1215
: base(original, copy, parentId, parentKey, messages)
1316
{
1417
}
1518

19+
/// <summary>
20+
/// Initializes a new instance of the <see cref="ContentCopyingNotification"/>.
21+
/// </summary>
22+
/// <param name="original">
23+
/// Gets the original <see cref="IContent"/> object.
24+
/// </param>
25+
/// <param name="copy">
26+
/// Gets the <see cref="IContent"/> object being copied.
27+
/// </param>
28+
/// <param name="parentId">
29+
/// Gets the ID of the parent of the <see cref="IContent"/> being copied.
30+
/// </param>
31+
/// <param name="messages">
32+
/// Initializes a new instance of the <see cref="EventMessages"/>.
33+
/// </param>
1634
[Obsolete("Please use constructor that takes a parent key as well, scheduled for removal in v15")]
1735
public ContentCopyingNotification(IContent original, IContent copy, int parentId, EventMessages messages)
1836
: this(original, copy, parentId, null, messages)

src/Umbraco.Core/Notifications/ContentDeletedBlueprintNotification.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// A notification that is used to trigger the IContentService when the DeletedBlueprint method is called in the API.
10+
/// </summary>
911
public sealed class ContentDeletedBlueprintNotification : EnumerableObjectNotification<IContent>
1012
{
1113
public ContentDeletedBlueprintNotification(IContent target, EventMessages messages)
@@ -19,6 +21,8 @@ public ContentDeletedBlueprintNotification(IEnumerable<IContent> target, EventMe
1921
messages)
2022
{
2123
}
22-
24+
/// <summary>
25+
/// The collection of deleted blueprint IContent.
26+
/// </summary>
2327
public IEnumerable<IContent> DeletedBlueprints => Target;
2428
}

src/Umbraco.Core/Notifications/ContentDeletedNotification.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// A notification that is used to trigger the IContentService when the Delete and EmptyRecycleBin methods are called in the API.
10+
/// </summary>
911
public sealed class ContentDeletedNotification : DeletedNotification<IContent>
1012
{
1113
public ContentDeletedNotification(IContent target, EventMessages messages)

src/Umbraco.Core/Notifications/ContentDeletedVersionsNotification.cs

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,29 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// 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.
10+
/// </summary>
911
public sealed class ContentDeletedVersionsNotification : DeletedVersionsNotification<IContent>
1012
{
13+
/// <summary>
14+
/// Initializes a new instance of the <see cref="ContentDeletedVersionsNotification"/>.
15+
/// </summary>
16+
/// <param name="id">
17+
/// Gets the ID of the <see cref="IContent"/> object being deleted.
18+
/// </param>
19+
/// <param name="messages">
20+
/// Initializes a new instance of the <see cref="EventMessages"/>.
21+
/// </param>
22+
/// <param name="specificVersion">
23+
/// Gets the id of the IContent object version being deleted.
24+
/// </param>
25+
/// <param name="deletePriorVersions">
26+
/// False by default.
27+
/// </param>
28+
/// <param name="dateToRetain">
29+
/// Gets the latest version date.
30+
/// </param>
1131
public ContentDeletedVersionsNotification(
1232
int id,
1333
EventMessages messages,

src/Umbraco.Core/Notifications/ContentDeletingNotification.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// A notification that is used to trigger the IContentService when the DeleteContentOfType, Delete and EmptyRecycleBin methods are called in the API.
10+
/// </summary>
911
public sealed class ContentDeletingNotification : DeletingNotification<IContent>
1012
{
1113
public ContentDeletingNotification(IContent target, EventMessages messages)

src/Umbraco.Core/Notifications/ContentDeletingVersionsNotification.cs

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,29 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// A notification that is used to trigger the IContentService when the DeleteVersion and DeleteVersions methods are called in the API.
10+
/// </summary>
911
public sealed class ContentDeletingVersionsNotification : DeletingVersionsNotification<IContent>
1012
{
13+
/// <summary>
14+
/// Initializes a new instance of the <see cref="ContentDeletingVersionsNotification"/>.
15+
/// </summary>
16+
/// <param name="id">
17+
/// Gets the ID of the <see cref="IContent"/> object being deleted.
18+
/// </param>
19+
/// <param name="messages">
20+
/// Initializes a new instance of the <see cref="EventMessages"/>.
21+
/// </param>
22+
/// <param name="specificVersion">
23+
/// Gets the id of the IContent object version being deleted.
24+
/// </param>
25+
/// <param name="deletePriorVersions">
26+
/// False by default.
27+
/// </param>
28+
/// <param name="dateToRetain">
29+
/// Gets the latest version date.
30+
/// </param>
1131
public ContentDeletingVersionsNotification(int id, EventMessages messages, int specificVersion = default, bool deletePriorVersions = false, DateTime dateToRetain = default)
1232
: base(id, messages, specificVersion, deletePriorVersions, dateToRetain)
1333
{

src/Umbraco.Core/Notifications/ContentEmptiedRecycleBinNotification.cs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,20 @@
55
using Umbraco.Cms.Core.Models;
66

77
namespace Umbraco.Cms.Core.Notifications;
8-
8+
/// <summary>
9+
/// A notification that is used to trigger the IContentService when the EmptyRecycleBin method is called in the API, after the RecycleBin has been deleted.
10+
/// </summary>
911
public sealed class ContentEmptiedRecycleBinNotification : EmptiedRecycleBinNotification<IContent>
1012
{
13+
/// <summary>
14+
/// Initializes a new instance of the <see cref="ContentEmptyingRecycleBinNotification"/>
15+
/// </summary>
16+
/// <param name="deletedEntities">
17+
/// The collection of deleted IContent object.
18+
/// </param>
19+
/// <param name="messages">
20+
/// Initializes a new instance of the <see cref="EventMessages"/>.
21+
/// </param>
1122
public ContentEmptiedRecycleBinNotification(IEnumerable<IContent> deletedEntities, EventMessages messages)
1223
: base(
1324
deletedEntities, messages)

0 commit comments

Comments
 (0)