PocketSharp/README.md

PocketSharp

This project is work in progress. PocketSharp will be released as a NuGet package when ready.

PocketSharp is a C#.NET class library, that integrates the Pocket API v3 and consists of 4 parts:

• Authentication
• Retrieve
• Modify
• Add

---

If you don't know Pocket, be sure to check it out. It's an awesome service, which lets you save articles, videos, ... in the cloud and access it from all your devices.

---

Usage Example

Request a Consumer Key on Pocket.

Include the PocketSharp namespace and it's associated models (you will need them later):

using PocketSharp;
using PocketSharp.Models;

Initialize PocketClient with:

PocketClient _client = new PocketClient("[YOUR_CONSUMER_KEY]", "[YOUR_ACCESS_CODE]");

Do a simple request - e.g. a search for CSS:

_client.Search("css").ForEach(
	item => Console.WriteLine(item.ID + " | " + item.Title)
);

Which will output:

330361896 | CSS Front-end Frameworks with comparison : By usabli.ca
345541438 | Editr - HTML, CSS, JavaScript playground
251743431 | CSS Architecture
343693149 | CSS3 Transitions - Thank God We Have A Specification!
...

Create an instance

Constructor:

PocketClient(string consumerKey, string accessCode = null, Uri callbackUri = null)

consumerKey: The API key
accessCode: Provide an access code if the user is already authenticated
callbackUri: The callback URL is called by Pocket after authentication

Example:

PocketClient _client = new PocketClient(
	consumerKey: "123498237423498723498723",
	callbackUri: new Uri("http://ceecore.com"),
	accessCode: "097809-oi987-izi8-jk98-oiuu89"
);

You can change the Access Code after initialization:

_client.AccessCode = "[YOU_ACCESS_CODE]";

Before authentication you will need to provide the callbackUri for authentication requests.
After authentication you will need to provide the accessCode.

Authentication

In order to communicate with a Pocket User, you will need a consumer key (which is generated by creating a new application on Pocket) and an Access Code.

The authentication is a 3-step process:

1) Generate authentication URI

Receive the request code and authentication URI from the library by calling string GetRequestCode():

string requestCode = _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

The request code is stored internally, but you can also provide it as param in GenerateAuthenticationUri(string requestCode = null).

2) Redirect to Pocket

Next you need to redirect the user to the authenticationUri, which displays a prompt to grant permissions for the application (see image). After the user granted or denied, he/she is redirected to the callbackUri.

3) Get Access Code

Call string GetAccessCode(string requestCode = null)

string accessCode = _client.GetAccessCode();
// fa8bfc16-69b3-4d22-7db7-84a58d

Again, the received access code is stored internally. Note that GetAccessCode can only be called with an existing request code. If you need to re-authenticate a user, start again with Step 1).

Important

Be sure to permanently store the Access Code for your user.
Without it you would always have to redo the authentication process.

Retrieve

Find items by a tag:

List<PocketItem> items = _client.SearchByTag("tutorial");

Find items by a search string:

List<PocketItem> items = _client.Search("css");

Find items by a filter:

List<PocketItem> items = _client.Retrieve(RetrieveFilter.Favorite); // only favorites

The RetrieveFilter Enum is specified as follows:

enum RetrieveFilter { All, Unread, Archive, Favorite, Article, Video, Image }

Custom Parameters

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 = _client.Retrieve(parameters);

Add

Adds a new item to your pocket list. Accepts four parameters, with uri being required.

PocketItem Add(Uri uri, string[] tags = null, string title = null, string tweetID = null)

Example:

PocketItem newItem = _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.

Modify

All Modify methods accept either the itemID (as int) or a PocketItem as parameter.

Archive the specified item:

bool isSuccess = _client.Archive(myPocketItem);

Un-archive the specified item:

bool isSuccess = _client.Unarchive(myPocketItem);

Favorites the specified item:

bool isSuccess = _client.Favorite(myPocketItem);

Un-favorites the specified item:

bool isSuccess = _client.Unfavorite(myPocketItem);

Deletes the specified item:

bool isSuccess = _client.Delete(myPocketItem);

Modify tags

Add tags to the specified item:

bool isSuccess = _client.AddTags(myPocketItem, new string[] { "css", "2013" });

Remove tags from the specified item:

bool isSuccess = _client.RemoveTags(myPocketItem, new string[] { "css", "2013" });

Remove all tags from the specified item:

bool isSuccess = _client.RemoveTags(myPocketItem);

Replaces all existing tags with new ones for the specified item:

bool isSuccess = _client.ReplaceTags(myPocketItem, new string[] { "css", "2013" });

Renames a tag for the specified item:

bool isSuccess = _client.RenameTag(myPocketItem, "oldTagName", "newTagName");

---

Release History

• 2013-07-01 v0.3.0-pre update authentication process (breaking)
• 2013-06-27 v0.2.0 add, modify item & modify tags
• 2013-06-26 v0.1.0 authentication & retrieve functionality

Contributors

Tobias Klika @ceee