Merge pull request #174 from Kentico/Items_feed_response_fix

Add interface for DeliveryItemsFeed

Kentico.Kontent.Delivery/DeliveryClient.cs

@@ -219,7 +219,7 @@ public async Task<DeliveryItemListingResponse<T>> GetItemsAsync<T>(IEnumerable<I
         /// </summary>
         /// <param name="parameters">An array of query parameters, for example, for filtering or ordering.</param>
         /// <returns>The <see cref="DeliveryItemsFeed"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        public DeliveryItemsFeed GetItemsFeed(params IQueryParameter[] parameters)
+        public IDeliveryItemsFeed GetItemsFeed(params IQueryParameter[] parameters)
         {
             return GetItemsFeed((IEnumerable<IQueryParameter>) parameters);
         }
@@ -229,7 +229,7 @@ public DeliveryItemsFeed GetItemsFeed(params IQueryParameter[] parameters)
         /// </summary>
         /// <param name="parameters">A collection of query parameters, for example, for filtering or ordering.</param>
         /// <returns>The <see cref="DeliveryItemsFeed"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        public DeliveryItemsFeed GetItemsFeed(IEnumerable<IQueryParameter> parameters)
+        public IDeliveryItemsFeed GetItemsFeed(IEnumerable<IQueryParameter> parameters)
         {
             ValidateItemsFeedParameters(parameters);
             var endpointUrl = UrlBuilder.GetItemsFeedUrl(parameters);
@@ -248,7 +248,7 @@ async Task<DeliveryItemsFeedResponse> GetItemsBatchAsync(string continuationToke
         /// <typeparam name="T">Type of the model. (Or <see cref="object"/> if the return type is not yet known.)</typeparam>
         /// <param name="parameters">An array of query parameters, for example, for filtering or ordering.</param>
         /// <returns>The <see cref="DeliveryItemsFeed{T}"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        public DeliveryItemsFeed<T> GetItemsFeed<T>(params IQueryParameter[] parameters)
+        public IDeliveryItemsFeed<T> GetItemsFeed<T>(params IQueryParameter[] parameters)
         {
             return GetItemsFeed<T>((IEnumerable<IQueryParameter>) parameters);
         }
@@ -259,7 +259,7 @@ public DeliveryItemsFeed<T> GetItemsFeed<T>(params IQueryParameter[] parameters)
         /// <typeparam name="T">Type of the model. (Or <see cref="object"/> if the return type is not yet known.)</typeparam>
         /// <param name="parameters">A collection of query parameters, for example, for filtering or ordering.</param>
         /// <returns>The <see cref="DeliveryItemsFeed{T}"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        public DeliveryItemsFeed<T> GetItemsFeed<T>(IEnumerable<IQueryParameter> parameters)
+        public IDeliveryItemsFeed<T> GetItemsFeed<T>(IEnumerable<IQueryParameter> parameters)
         {
             var enhancedParameters = ExtractParameters<T>(parameters).ToList();
             ValidateItemsFeedParameters(enhancedParameters);

Kentico.Kontent.Delivery/IDeliveryClient.cs

@@ -92,31 +92,31 @@ public interface IDeliveryClient
         /// Returns a feed that is used to traverse through content items matching the optional filtering parameters.
         /// </summary>
         /// <param name="parameters">A collection of query parameters, for example, for filtering or ordering.</param>
-        /// <returns>The <see cref="DeliveryItemsFeed"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        DeliveryItemsFeed GetItemsFeed(params IQueryParameter[] parameters);
+        /// <returns>The <see cref="IDeliveryItemsFeed"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
+        IDeliveryItemsFeed GetItemsFeed(params IQueryParameter[] parameters);
 
         /// <summary>
         /// Returns a feed that is used to traverse through content items matching the optional filtering parameters.
         /// </summary>
         /// <param name="parameters">A collection of query parameters, for example, for filtering or ordering.</param>
-        /// <returns>The <see cref="DeliveryItemsFeed"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        DeliveryItemsFeed GetItemsFeed(IEnumerable<IQueryParameter> parameters);
+        /// <returns>The <see cref="IDeliveryItemsFeed"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
+        IDeliveryItemsFeed GetItemsFeed(IEnumerable<IQueryParameter> parameters);
 
         /// <summary>
         /// Returns a feed that is used to traverse through strongly typed content items matching the optional filtering parameters.
         /// </summary>
         /// <typeparam name="T">Type of the model. (Or <see cref="object"/> if the return type is not yet known.)</typeparam>
         /// <param name="parameters">A collection of query parameters, for example, for filtering or ordering.</param>
-        /// <returns>The <see cref="DeliveryItemsFeed{T}"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        DeliveryItemsFeed<T> GetItemsFeed<T>(params IQueryParameter[] parameters);
+        /// <returns>The <see cref="IDeliveryItemsFeed{T}"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
+        IDeliveryItemsFeed<T> GetItemsFeed<T>(params IQueryParameter[] parameters);
 
         /// <summary>
         /// Returns a feed that is used to traverse through strongly typed content items matching the optional filtering parameters.
         /// </summary>
         /// <typeparam name="T">Type of the model. (Or <see cref="object"/> if the return type is not yet known.)</typeparam>
         /// <param name="parameters">A collection of query parameters, for example, for filtering or ordering.</param>
-        /// <returns>The <see cref="DeliveryItemsFeed{T}"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
-        DeliveryItemsFeed<T> GetItemsFeed<T>(IEnumerable<IQueryParameter> parameters);
+        /// <returns>The <see cref="IDeliveryItemsFeed{T}"/> instance that can be used to enumerate through content items. If no query parameters are specified, all content items are enumerated.</returns>
+        IDeliveryItemsFeed<T> GetItemsFeed<T>(IEnumerable<IQueryParameter> parameters);
 
         /// <summary>
         /// Returns a content type as JSON data.

Kentico.Kontent.Delivery/Responses/DeliveryItemsFeed.cs

@@ -6,7 +6,7 @@ namespace Kentico.Kontent.Delivery
     /// <summary>
     /// Represents a feed that can be used to retrieve content items from Kentico Kontent Delivery API in smaller batches.
     /// </summary>
-    public class DeliveryItemsFeed
+    public class DeliveryItemsFeed : IDeliveryItemsFeed
     {
         internal delegate Task<DeliveryItemsFeedResponse> GetFeedResponse(string continuationToken);
 

Kentico.Kontent.Delivery/Responses/IDeliveryItemsFeed.cs

@@ -0,0 +1,21 @@
+using System.Threading.Tasks;
+
+namespace Kentico.Kontent.Delivery
+{
+    /// <summary>
+    /// Represents a feed that can be used to retrieve content items from Kentico Kontent Delivery API in smaller batches.
+    /// </summary>
+    public interface IDeliveryItemsFeed
+    {
+        /// <summary>
+        /// Indicates whether there are more batches to fetch.
+        /// </summary>
+        bool HasMoreResults { get; }
+
+        /// <summary>
+        /// Retrieves the next feed batch if available.
+        /// </summary>
+        /// <returns>Instance of <see cref="DeliveryItemsFeedResponse"/> class that contains a list of content items.</returns>
+        Task<DeliveryItemsFeedResponse> FetchNextBatchAsync();
+    }
+}

Kentico.Kontent.Delivery/StrongTyping/DeliveryItemsFeed.cs

@@ -7,7 +7,7 @@ namespace Kentico.Kontent.Delivery
     /// Represents a feed that can be used to retrieve strongly typed content items from Kentico Kontent Delivery API in smaller batches.
     /// </summary>
     /// <typeparam name="T">The type of content items in the feed.</typeparam>
-    public class DeliveryItemsFeed<T>
+    public class DeliveryItemsFeed<T> : IDeliveryItemsFeed<T>
     {
         internal delegate Task<DeliveryItemsFeedResponse<T>> GetFeedResponse(string continuationToken);
 

Kentico.Kontent.Delivery/StrongTyping/IDeliveryItemsFeed.cs

@@ -0,0 +1,22 @@
+using System.Threading.Tasks;
+
+namespace Kentico.Kontent.Delivery
+{
+    /// <summary>
+    /// Represents a feed that can be used to retrieve strongly typed content items from Kentico Kontent Delivery API in smaller batches.
+    /// </summary>
+    /// <typeparam name="T">The type of content items in the feed.</typeparam>
+    public interface IDeliveryItemsFeed<T>
+    {
+        /// <summary>
+        /// Indicates whether there are more batches to fetch.
+        /// </summary>
+        bool HasMoreResults { get; }
+
+        /// <summary>
+        /// Retrieves the next feed batch if available.
+        /// </summary>
+        /// <returns>Instance of <see cref="DeliveryItemsFeedResponse{T}"/> class that contains a list of strongly typed content items.</returns>
+        Task<DeliveryItemsFeedResponse<T>> FetchNextBatchAsync();
+    }
+}