From 44376c08522c9430120bd6e60fcf7e2cb811add6 Mon Sep 17 00:00:00 2001 From: Tobias Klika Date: Fri, 15 Nov 2013 14:30:20 +0100 Subject: [PATCH] IPocketReader interface --- PocketSharp.Reader/IPocketReader.cs | 35 ++++++++++++++++++++ PocketSharp.Reader/PocketReader.cs | 2 +- PocketSharp.Reader/PocketSharp.Reader.csproj | 1 + 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 PocketSharp.Reader/IPocketReader.cs diff --git a/PocketSharp.Reader/IPocketReader.cs b/PocketSharp.Reader/IPocketReader.cs new file mode 100644 index 0000000..510140e --- /dev/null +++ b/PocketSharp.Reader/IPocketReader.cs @@ -0,0 +1,35 @@ +using PocketSharp.Models; +using System; +using System.Threading.Tasks; + +namespace PocketSharp +{ + public interface IPocketReader + { + /// + /// Reads article content from the given URI. + /// This method does not use the official Article View API, which is private. + /// The PocketReader is based on a custom PCL port of NReadability and SgmlReader. + /// + /// An URI. + /// if set to true [only body is returned]. + /// if set to true [no headline (h1) is included]. + /// A Pocket article with extracted content and title. + /// + Task Read(Uri uri, bool bodyOnly = true, bool noHeadline = false); + + /// + /// Reads article content from the given PocketItem. + /// This method does not use the official Article View API, which is private. + /// The PocketReader is based on a custom PCL port of NReadability and SgmlReader. + /// + /// The pocket item. + /// if set to true [only body is returned]. + /// if set to true [no headline (h1) is included]. + /// + /// A Pocket article with extracted content and title. + /// + /// + Task Read(PocketItem item, bool bodyOnly = true, bool noHeadline = false); + } +} \ No newline at end of file diff --git a/PocketSharp.Reader/PocketReader.cs b/PocketSharp.Reader/PocketReader.cs index fac28c1..8340938 100644 --- a/PocketSharp.Reader/PocketReader.cs +++ b/PocketSharp.Reader/PocketReader.cs @@ -10,7 +10,7 @@ namespace PocketSharp /// /// PocketReader /// - public class PocketReader + public class PocketReader : IPocketReader { /// /// Used UserAgent for HTTP request diff --git a/PocketSharp.Reader/PocketSharp.Reader.csproj b/PocketSharp.Reader/PocketSharp.Reader.csproj index 95dc136..447366e 100644 --- a/PocketSharp.Reader/PocketSharp.Reader.csproj +++ b/PocketSharp.Reader/PocketSharp.Reader.csproj @@ -39,6 +39,7 @@ +