diff --git a/PocketSharp.Website/index.html b/PocketSharp.Website/index.html index 7ac6902..4518de8 100644 --- a/PocketSharp.Website/index.html +++ b/PocketSharp.Website/index.html @@ -32,6 +32,8 @@
PocketSharp is a C#.NET class library, that integrates the Pocket API v3
+
+ Current version: 1.2.0
Install-Package PocketSharp
@@ -122,6 +124,8 @@ using PocketSharp.Models;
GetAccessCode can only be called with an existing req
Get list of all items:
- -List<PocketItem> items = await _client.Retrieve();
-// equivalent to: await _client.Retrieve(RetrieveFilter.All)
-
- Find items by a tag:
- -List<PocketItem> items = await _client.SearchByTag("tutorial");
-
- Find items by a search string:
- -List<PocketItem> items = await _client.Search("css");
-
- Find items by a filter:
- -List<PocketItem> items = await _client.Retrieve(RetrieveFilter.Favorite); // only favorites
-
- The RetrieveFilter Enum is specified as follows:
- -enum RetrieveFilter { All, Unread, Archive, Favorite, Article, Video, Image }
-
- You can create a completely custom parameter list for retrieval with the POCO RetrieveParameters:
-var parameters = new RetrieveParameters()
-{
- Count = 50,
- Offset = 100,
- Sort = SortEnum.oldest
- ...
-};
-List<pocketitem> items = await _client.Retrieve(parameters);
-
-
+Get list of all items:
+List<PocketItem> items = await _client.Retrieve();
+// equivalent to: await _client.RetrieveByFilter(RetrieveFilter.All)
+Get a list with specific parameters (explanation in the Pocket Docs):
+List<PocketItem> items = await _client.Retrieve(
+ State? state = null,
+ bool? favorite = null,
+ string tag = null,
+ ContentType? contentType = null,
+ Sort? sort = null,
+ string search = null,
+ string domain = null,
+ DateTime? since = null,
+ int? count = null,
+ int? offset = null
+);
+It's best to use parameters as named parameters, to avoid typing null values:
List<PocketItem> items = await _client.Retrieve(count: 10, offset: 20, sort: Sort.oldest);
+Find items by a tag:
+List<PocketItem> items = await _client.SearchByTag("tutorial");
+Find items by a search string:
+List<PocketItem> items = await _client.Search("css");
+Get a filtered list:
+List<PocketItem> items = await _client.RetrieveByFilter(RetrieveFilter.Favorite);
+// returns favorites only
+The RetrieveFilter Enum is specified as follows:
+enum RetrieveFilter { All, Unread, Archive, Favorite, Article, Video, Image }