C# Class GoodReadsSharp.GoodReadsClient

Afficher le fichier Open project: AnalogJ/GoodReadsSharp

Private Properties

Свойство	Type	Description
AuthMethods	IAuthenticator
LoadClient	void
PublicMethods	IAuthenticator

Méthodes publiques

Méthode	Description
AccountInfo ( ) : AuthUser
AddBookToShelf ( String shelfName, String bookId ) : Shelf	Add a book to a shelf using OAuth. This method can also be used to remove from shelf. You'll need to register your app (required).
AddShelf ( String shelfName ) : void
AddToOwnedBooks ( String bookId ) : AddToOwnedBooks
BookIdForIsbn ( String isbn, System.Boolean &success ) : Book
BuildAuthorizeUrl ( string callbackUrl = null ) : String
DeleteShelf ( String shelfId ) : void
GetAccessToken ( ) : UserLogin
GetToken ( ) : UserLogin	Gets a token from goodreads.com (Token cant be used until authorized!)
GetTokenAndBuildUrl ( string callback = null ) : String
GoodReadsClient ( string apiKey, string appSecret ) : System	Default Constructor for the DropboxClient
GoodReadsClient ( string apiKey, string appSecret, string userToken, string userSecret ) : System	Creates an instance of the DropNetClient given an API Key/Secret and a User Token/Secret Make sure to call AccountInfo() Method first, without the _userToken.ID field populated the api wont work.
ListBooksOnShelf ( String shelfName, Int32 page = 1 ) : ListBooksOnShelf	Lists the books on shelf.
ListOwnedBooks ( Int32 page = 1 ) : ListOwnedBooks	Returns a list of books owned by the user.
ListShelves ( Int32 page = 1 ) : ListShelves	Lists shelves for a user
RemoveBookFromShelf ( String shelfName, String bookId ) : Hash
ReviewCountsForIsbns ( List isbns ) : ReviewCountsForIsbns	Reviews the counts for isbns. Only populates the Id, Isbn and Isbn13 fields

Private Methods

Méthode	Description
AuthMethods ( ) : IAuthenticator
LoadClient ( ) : void
PublicMethods ( ) : IAuthenticator

Method Details

AccountInfo() public méthode

public AccountInfo ( ) : AuthUser
Résultat	AuthUser

AddBookToShelf() public méthode

Add a book to a shelf using OAuth. This method can also be used to remove from shelf. You'll need to register your app (required).

public AddBookToShelf ( String shelfName, String bookId ) : Shelf
shelfName	String
bookId	String
Résultat	GoodReadsSharp.Models.Shelf

AddShelf() public méthode

public AddShelf ( String shelfName ) : void
shelfName	String
Résultat	void

AddToOwnedBooks() public méthode

public AddToOwnedBooks ( String bookId ) : AddToOwnedBooks
bookId	String
Résultat	AddToOwnedBooks

BookIdForIsbn() public méthode

public BookIdForIsbn ( String isbn, System.Boolean &success ) : Book
isbn	String
success	System.Boolean
Résultat	GoodReadsSharp.Models.Book

BuildAuthorizeUrl() public méthode

public BuildAuthorizeUrl ( string callbackUrl = null ) : String
callbackUrl	string
Résultat	String

DeleteShelf() public méthode

public DeleteShelf ( String shelfId ) : void
shelfId	String
Résultat	void

GetAccessToken() public méthode

public GetAccessToken ( ) : UserLogin
Résultat	GoodReadsSharp.Models.UserLogin

GetToken() public méthode

Gets a token from goodreads.com (Token cant be used until authorized!)

public GetToken ( ) : UserLogin
Résultat	GoodReadsSharp.Models.UserLogin

GetTokenAndBuildUrl() public méthode

public GetTokenAndBuildUrl ( string callback = null ) : String
callback	string
Résultat	String

GoodReadsClient() public méthode

Default Constructor for the DropboxClient

public GoodReadsClient ( string apiKey, string appSecret ) : System
apiKey	string	The Api Key to use for the Dropbox Requests
appSecret	string	The Api Secret to use for the Dropbox Requests
Résultat	System

GoodReadsClient() public méthode

Creates an instance of the DropNetClient given an API Key/Secret and a User Token/Secret Make sure to call AccountInfo() Method first, without the _userToken.ID field populated the api wont work.

public GoodReadsClient ( string apiKey, string appSecret, string userToken, string userSecret ) : System
apiKey	string	The Api Key to use for the Dropbox Requests
appSecret	string	The Api Secret to use for the Dropbox Requests
userToken	string	The User authentication token
userSecret	string	The Users matching secret
Résultat	System

ListBooksOnShelf() public méthode

Lists the books on shelf.

public ListBooksOnShelf ( String shelfName, Int32 page = 1 ) : ListBooksOnShelf
shelfName	String	Name of the shelf.
page	System.Int32	The page.
Résultat	ListBooksOnShelf

ListOwnedBooks() public méthode

Returns a list of books owned by the user.

public ListOwnedBooks ( Int32 page = 1 ) : ListOwnedBooks
page	System.Int32
Résultat	ListOwnedBooks

ListShelves() public méthode

Lists shelves for a user

public ListShelves ( Int32 page = 1 ) : ListShelves
page	System.Int32	The page.
Résultat	ListShelves

RemoveBookFromShelf() public méthode

public RemoveBookFromShelf ( String shelfName, String bookId ) : Hash
shelfName	String
bookId	String
Résultat	GoodReadsSharp.Models.Hash

ReviewCountsForIsbns() public méthode

Reviews the counts for isbns. Only populates the Id, Isbn and Isbn13 fields

public ReviewCountsForIsbns ( List isbns ) : ReviewCountsForIsbns
isbns	List	The isbns.
Résultat	ReviewCountsForIsbns