+
-
+
Supported platforms
+PocketSharp is a Portable Class Library (since 1.0.0), therefore it's compatible with multiple platforms:
+-
+
- .NET >= 4.0.3 (including WPF) +
- Silverlight >= 4 +
- Windows Phone >= 7.5 +
- Windows Store +
You can find examples for Silverlight 5, WP8 and WPF in the PocketSharp.Examples folder.
Async Support
+All public methods, which communicate with the Pocket servers are asynchronous. So they should be called with the preceding await keyword, and the encapsulated method marked with async.
In PocketSharp versions < 1.0.0 all methods lacked async support and were blocking.
+Getting Started
Request a Consumer Key on Pocket.
Include the PocketSharp namespace and it's associated models (you will need them later):
@@ -66,8 +79,8 @@ using PocketSharp.Models;Do a simple request - e.g. a search for CSS:
_client.Search("css").ForEach(
- item => Console.WriteLine(item.ID + " | " + item.Title)
+ await _client.Search("css").ForEach(
+ item => Debug.WriteLine(item.ID + " | " + item.Title)
);
Which will output:
@@ -109,6 +122,7 @@ using PocketSharp.Models;Release History
-
+
- 2013-09-15 v1.0.0 convert to PCL & implement async
- 2013-08-16 v0.3.2 tag modification fixed and full retrieval of items for Retrieve method
- 2013-07-07 v0.3.1 authentication fixes
- 2013-07-02 v0.3.0 update authentication process @@ -117,8 +131,9 @@ using PocketSharp.Models;
Used Packages
Contributors
@@ -138,7 +153,7 @@ using PocketSharp.Models;
1) Generate authentication URI
Receive the request code and authentication URI from the library by calling string GetRequestCode():
string requestCode = _client.GetRequestCode();
+ string requestCode = await _client.GetRequestCode();
// 0f453f2d-1605-8584-28fd-39af8e
Uri authenticationUri = _client.GenerateAuthenticationUri();
// https://getpocket.com/auth/authorize?request_token=0f453f2d-1605-8584-28fd-39af8e&redirect_uri=http%253a%252f%252fceecore.com
@@ -149,9 +164,9 @@ Uri authenticationUri = _client.GenerateAuthenticationUri();
3) Get Access Code
- Call string GetAccessCode(string requestCode = null)
+ Call Task<string> GetAccessCode(string requestCode = null)
- string accessCode = _client.GetAccessCode();
+ string accessCode = await _client.GetAccessCode();
// fa8bfc16-69b3-4d22-7db7-84a58d
@@ -164,29 +179,29 @@ Note that GetAccessCode can only be called with an existing req
Without it you would always have to redo the authentication process.
-
+
Retrieve
Get list of all items:
-List<PocketItem> items = _client.Retrieve();
-// equivalent to: _client.Retrieve(RetrieveFilter.All)List<PocketItem> items = await _client.Retrieve();
+// equivalent to: await _client.Retrieve(RetrieveFilter.All)Find items by a tag:
-List<PocketItem> items = _client.SearchByTag("tutorial");List<PocketItem> items = await _client.SearchByTag("tutorial");Find items by a search string:
-List<PocketItem> items = _client.Search("css");List<PocketItem> items = await _client.Search("css");Find items by a filter:
-List<PocketItem> items = _client.Retrieve(RetrieveFilter.Favorite); // only favoritesList<PocketItem> items = await _client.Retrieve(RetrieveFilter.Favorite); // only favoritesThe RetrieveFilter Enum is specified as follows:
@@ -203,7 +218,7 @@ var parameters = new RetrieveParameters() Sort = SortEnum.oldest ... }; -List<pocketitem> items = _client.Retrieve(parameters); +List<pocketitem> items = await _client.Retrieve(parameters); @@ -217,63 +232,63 @@ List<pocketitem> items = _client.Retrieve(parameters); Accepts four parameters, withuri being required.
- PocketItem Add(Uri uri, string[] tags = null, string title = null, string tweetID = null)Task<PocketItem> Add(Uri uri, string[] tags = null, string title = null, string tweetID = null)Example:
-PocketItem newItem = _client.Add(
+ PocketItem newItem = await _client.Add(
new Uri("http:⁄⁄www.neowin.net/news/full-build-2013-conference-sessions-listing-revealed"),
new string[] { "microsoft", "neowin", "build" }
);
The title can be included for cases where an item does not have a title, which is typical for image or PDF URLs. If Pocket detects a title from the content of the page, this parameter will be ignored.
If you are adding Pocket support to a Twitter client, please send along a reference to the tweet status id (with the tweetID). This allows Pocket to show the original tweet alongside the article.
-
+
-
+
diff --git a/README.md b/README.md
index bfd5165..345026c 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,6 @@
-**PocketSharp** is a C#.NET class library, that integrates the [Pocket API v3](http://getpocket.com/developer) and consists of 4 parts:
-
-- Authentication
-- Retrieve
-- Modify
-- Add
+**PocketSharp** is a C#.NET class library, that integrates the [Pocket API v3](http://getpocket.com/developer) and consists of 4 parts: [Authentication](#authentication), [Retrieve](#retrieve), [Modify](#modify) and [Add](#add).
[pocketsharp.frontendplay.com](http://pocketsharp.frontendplay.com/)
@@ -15,6 +10,23 @@
Install-Package PocketSharp
```
+## Supported platforms
+
+PocketSharp is a **Portable Class Library** (since 1.0.0), therefore it's compatible with multiple platforms:
+
+- **.NET** >= 4.0.3 (including WPF)
+- **Silverlight** >= 4
+- **Windows Phone** >= 7.5
+- **Windows Store**
+
+You can find examples for Silverlight 5, WP8 and WPF in the `PocketSharp.Examples` folder.
+
+## Async Support
+
+All public methods, which communicate with the Pocket servers are asynchronous. So they should be called with the preceding `await` keyword, and the encapsulated method marked with `async`.
+
+_In PocketSharp versions < 1.0.0 all methods lacked async support and were blocking._
+
## Usage Example
Request a [Consumer Key on Pocket.](http://getpocket.com/developer/apps/)
@@ -35,8 +47,9 @@ PocketClient _client = new PocketClient("[YOUR_CONSUMER_KEY]", "[YOUR_ACCESS_COD
Do a simple request - e.g. a search for `CSS`:
```csharp
-_client.Search("css").ForEach(
- item => Console.WriteLine(item.ID + " | " + item.Title)
+var items = await _client.Search("css");
+items.ForEach(
+ item => Debug.Write(item.ID + " | " + item.Title)
);
```
@@ -93,7 +106,7 @@ The authentication is a 3-step process:
Receive the **request code** and **authentication URI** from the library by calling `string GetRequestCode()`:
```csharp
-string requestCode = _client.GetRequestCode();
+string requestCode = await _client.GetRequestCode();
// 0f453f2d-1605-8584-28fd-39af8e
Uri authenticationUri = _client.GenerateAuthenticationUri();
// https://getpocket.com/auth/authorize?request_token=0f453f2d-1605-8584-28fd-39af8e&redirect_uri=http%253a%252f%252fceecore.com
@@ -107,10 +120,10 @@ Next you need to redirect the user to the `authenticationUri`, which displays a
#### 3) Get Access Code
-Call `string GetAccessCode(string requestCode = null)`
+Call `TaskModify
All Modify methods accept either the itemID (as int) or a PocketItem as parameter.
Archive the specified item:
-bool isSuccess = _client.Archive(myPocketItem);
+ bool isSuccess = await _client.Archive(myPocketItem);
Un-archive the specified item:
- bool isSuccess = _client.Unarchive(myPocketItem);
+ bool isSuccess = await _client.Unarchive(myPocketItem);
Favorites the specified item:
- bool isSuccess = _client.Favorite(myPocketItem);
+ bool isSuccess = await _client.Favorite(myPocketItem);
Un-favorites the specified item:
- bool isSuccess = _client.Unfavorite(myPocketItem);
+ bool isSuccess = await _client.Unfavorite(myPocketItem);
Deletes the specified item:
- bool isSuccess = _client.Delete(myPocketItem);
+ bool isSuccess = await _client.Delete(myPocketItem);
Modify tags
Add tags to the specified item:
- bool isSuccess = _client.AddTags(myPocketItem, new string[] { "css", "2013" });
+ bool isSuccess = await _client.AddTags(myPocketItem, new string[] { "css", "2013" });
Remove tags from the specified item:
- bool isSuccess = _client.RemoveTags(myPocketItem, new string[] { "css", "2013" });
+ bool isSuccess = await _client.RemoveTags(myPocketItem, new string[] { "css", "2013" });
Remove all tags from the specified item:
- bool isSuccess = _client.RemoveTags(myPocketItem);
+ bool isSuccess = await _client.RemoveTags(myPocketItem);
Replaces all existing tags with new ones for the specified item:
- bool isSuccess = _client.ReplaceTags(myPocketItem, new string[] { "css", "2013" });
+ bool isSuccess = await _client.ReplaceTags(myPocketItem, new string[] { "css", "2013" });
Renames a tag for the specified item:
- bool isSuccess = _client.RenameTag(myPocketItem, "oldTagName", "newTagName");
+ bool isSuccess = await _client.RenameTag(myPocketItem, "oldTagName", "newTagName");