C# Класс GoodReadsSharp.GoodReadsClient

Показать файл Открыть проект

Private Properties

Свойство Тип Описание
AuthMethods IAuthenticator
LoadClient void
PublicMethods IAuthenticator

Открытые методы

Метод Описание
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

Приватные методы

Метод Описание
AuthMethods ( ) : IAuthenticator
LoadClient ( ) : void
PublicMethods ( ) : IAuthenticator

Описание методов

AccountInfo() публичный Метод

public AccountInfo ( ) : AuthUser
Результат AuthUser

AddBookToShelf() публичный Метод

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
Результат GoodReadsSharp.Models.Shelf

AddShelf() публичный Метод

public AddShelf ( String shelfName ) : void
shelfName String
Результат void

AddToOwnedBooks() публичный Метод

public AddToOwnedBooks ( String bookId ) : AddToOwnedBooks
bookId String
Результат AddToOwnedBooks

BookIdForIsbn() публичный Метод

public BookIdForIsbn ( String isbn, System.Boolean &success ) : Book
isbn String
success System.Boolean
Результат GoodReadsSharp.Models.Book

BuildAuthorizeUrl() публичный Метод

public BuildAuthorizeUrl ( string callbackUrl = null ) : String
callbackUrl string
Результат String

DeleteShelf() публичный Метод

public DeleteShelf ( String shelfId ) : void
shelfId String
Результат void

GetAccessToken() публичный Метод

public GetAccessToken ( ) : UserLogin
Результат GoodReadsSharp.Models.UserLogin

GetToken() публичный Метод

Gets a token from goodreads.com (Token cant be used until authorized!)
public GetToken ( ) : UserLogin
Результат GoodReadsSharp.Models.UserLogin

GetTokenAndBuildUrl() публичный Метод

public GetTokenAndBuildUrl ( string callback = null ) : String
callback string
Результат String

GoodReadsClient() публичный Метод

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
Результат System

GoodReadsClient() публичный Метод

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
Результат System

ListBooksOnShelf() публичный Метод

Lists the books on shelf.
public ListBooksOnShelf ( String shelfName, Int32 page = 1 ) : ListBooksOnShelf
shelfName String Name of the shelf.
page System.Int32 The page.
Результат ListBooksOnShelf

ListOwnedBooks() публичный Метод

Returns a list of books owned by the user.
public ListOwnedBooks ( Int32 page = 1 ) : ListOwnedBooks
page System.Int32
Результат ListOwnedBooks

ListShelves() публичный Метод

Lists shelves for a user
public ListShelves ( Int32 page = 1 ) : ListShelves
page System.Int32 The page.
Результат ListShelves

RemoveBookFromShelf() публичный Метод

public RemoveBookFromShelf ( String shelfName, String bookId ) : Hash
shelfName String
bookId String
Результат GoodReadsSharp.Models.Hash

ReviewCountsForIsbns() публичный Метод

Reviews the counts for isbns. Only populates the Id, Isbn and Isbn13 fields
public ReviewCountsForIsbns ( List isbns ) : ReviewCountsForIsbns
isbns List The isbns.
Результат ReviewCountsForIsbns