totobogy edited this page Sep 14, 2012 · 7 revisions

Introduction

'ReadmillClient' is a .Net class library for building applications on, for and integrating with Readmill. The client is currently available for .Net 4.0 and Windows Phone 7.1 platforms and, in future, will be available for .Net 4.5 and Windows Phone 8. The sources are available under the Code section on this site while the binaries are available as a nuget package.

Please note that the project is currently under development and the binary release is a beta quality release. The detailed documentation is also under development. In the interim, the official Readmill API documentation is the ultimate reference point.

Note / Update

The current version of client (0.8.0.0 on nuget) targets V1 of the Readmill API. It will soon be updated (to version 2.0) to target V2 of the API which is now available. However, this current version will continue to be available but will be deprecated.

Quick Start

Installing ReadmillClient package from nuget

ReadmillClient is available as a nuget package here. In case you are new to it, nuget is a package manager that makes it easy to discover, install and manage third party extensions and libraries in Visual Studio.

Hello, World

Once you have installed the nuget package in your project (either .Net 4.0 or Windows Phone 7.1), using ReadmillClient should be straightforward. Here's a simple example that uses the client to get a list of latest 50 books added on Readmill and prints their title and author:

//Create a ReadmillClient object.
ReadmillClient client = new ReadmillClient("Readmill Client-ID of your Application goes here");

//Set Book query options
BooksQueryOptions options = new BooksQueryOptions();
options.CountValue = 50;

//Get Books from Readmill
List<Book> books = client.Books.GetBooksAsync(options).Result;

foreach (Book book in books)
  Console.WriteLine(book.Title + " by " + book.Author);

As a second example, the following code retrieves the Readmill profile details about the current (authorized) user. Note that the authorization with Readmill is based on OAuth 2.0 Readmill Client does not provide any support for OAuth - this needs to be handled separately by the application developer and a valid OAuth token passed to the client, as shown. This example also highlights the fact that the Readmill Client uses the Task based async pattern for all exposed api's.

ReadmillClient client = new ReadmillClient("CLIENT-ID");

client.Users.GetOwnerAsync("VALID OAuth ACCESS TOKEN").ContinueWith(
      (getUserTask) =>
      {
            Console.WriteLine("My Name is: " + getUserTask.Result.FullName);
 
      });    

Digging Deeper

The official Readmill API documentation, in combination with the Unit Tests available for the .Net 4.0 version of the library are probably the best way to explore further. A relatively simple Windows Phone application "Read7" using the Windows Phone version of the library is also available (and being developed) in the code section.

Detailed documentation of the client will be available soon on this site.

FAQ's

Please see the FAQ page for common questions and issues.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.