aboutsummaryrefslogtreecommitdiff
path: root/back-end/src/IRssFeedGenerator.cs
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2023-07-12 01:28:23 -0400
committerLibravatar vnugent <public@vaughnnugent.com>2023-07-12 01:28:23 -0400
commitf64955c69d91e578e580b409ba31ac4b3477da96 (patch)
tree16f01392ddf1abfea13d7d1ede3bfb0459fe8f0d /back-end/src/IRssFeedGenerator.cs
Initial commit
Diffstat (limited to 'back-end/src/IRssFeedGenerator.cs')
-rw-r--r--back-end/src/IRssFeedGenerator.cs43
1 files changed, 43 insertions, 0 deletions
diff --git a/back-end/src/IRssFeedGenerator.cs b/back-end/src/IRssFeedGenerator.cs
new file mode 100644
index 0000000..fcf4bf7
--- /dev/null
+++ b/back-end/src/IRssFeedGenerator.cs
@@ -0,0 +1,43 @@
+/*
+* Copyright (c) 2023 Vaughn Nugent
+*
+* Library: CMNext
+* Package: Content.Publishing.Blog.Admin
+* File: IRssFeedGenerator.cs
+*
+* CMNext is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* CMNext is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program. If not, see https://www.gnu.org/licenses/.
+*/
+
+using System.Collections.Generic;
+
+using VNLib.Utils.IO;
+
+using Content.Publishing.Blog.Admin.Model;
+
+namespace Content.Publishing.Blog.Admin
+{
+ /// <summary>
+ /// Represents a class that can generate an RSS feed from a collection of posts.
+ /// </summary>
+ internal interface IRssFeedGenerator
+ {
+ /// <summary>
+ /// Builds an XML RSS feed from the given posts and writes it to the given output stream.
+ /// </summary>
+ /// <param name="context">The channel context containing feed information</param>
+ /// <param name="posts">The collection of posts to publish to the feed</param>
+ /// <param name="output">The output stream</param>
+ void BuildFeed(IChannelContext context, IEnumerable<PostMeta> posts, VnMemoryStream output);
+ }
+}