C# Класс Com.Readmill.Api.BooksClient

Наследование: ReadmillClientBase
Показать файл Открыть проект

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

Метод Описание
BooksClient ( string clientId ) : System

Instantiates a client for the Readmill/Users api
GetBestMatchAsync ( BookMatchOptions options, CancellationToken cancellationToken = default(CancellationToken) ) : Task
GetBookByIdAsync ( string bookId, CancellationToken cancellationToken = default(CancellationToken) ) : Task
GetBookReadingsAsync ( string bookId, ReadingsQueryOptions options = null, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>

Get readings associated with the specified book
GetBooksAsync ( BooksQueryOptions options = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>

Retrieves a list of books.
PostBookAsync ( string accessToken, Book newBook ) : Task
PostBookReadingAsync ( string accessToken, string bookId, Reading state, bool isPrivate = false, string closingRemark = null ) : Task

Защищенные методы

Метод Описание
LoadTemplates ( ) : void

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

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

Instantiates a client for the Readmill/Users api
public BooksClient ( string clientId ) : System
clientId string Client Id of the application, assgined by Readmill when the app is registered
Результат System

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

public GetBestMatchAsync ( BookMatchOptions options, CancellationToken cancellationToken = default(CancellationToken) ) : Task
options BookMatchOptions
cancellationToken System.Threading.CancellationToken
Результат Task

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

public GetBookByIdAsync ( string bookId, CancellationToken cancellationToken = default(CancellationToken) ) : Task
bookId string
cancellationToken System.Threading.CancellationToken
Результат Task

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

Get readings associated with the specified book
public GetBookReadingsAsync ( string bookId, ReadingsQueryOptions options = null, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
bookId string Readmill Id of the book for which readings need to be retrieved
options ReadingsQueryOptions
accessToken string
cancellationToken System.Threading.CancellationToken
Результат Task>

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

Retrieves a list of books.
public GetBooksAsync ( BooksQueryOptions options = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
options BooksQueryOptions Query options for retrieving the books
cancellationToken System.Threading.CancellationToken
Результат Task>

LoadTemplates() защищенный Метод

protected LoadTemplates ( ) : void
Результат void

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

public PostBookAsync ( string accessToken, Book newBook ) : Task
accessToken string
newBook Com.Readmill.Api.DataContracts.Book
Результат Task

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

public PostBookReadingAsync ( string accessToken, string bookId, Reading state, bool isPrivate = false, string closingRemark = null ) : Task
accessToken string
bookId string
state Com.Readmill.Api.DataContracts.Reading
isPrivate bool
closingRemark string
Результат Task