C# Class Com.Readmill.Api.ReadingsClient

Inheritance: ReadmillClientBase

Mostrar archivo Open project: totobogy/ReadmillDotNet Class Usage Examples

Public Methods

Method	Description
DeleteReadingAsync ( string accessToken, string readingId ) : Task
GetReadingByIdAsync ( string readingId, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task
GetReadingCommentsAsync ( string readingId, RangeQueryOptions options = null, string accessToken = null ) : Task>
GetReadingHighlightsAsync ( string readingId, RangeQueryOptions options = null, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
GetReadingLocationsAsync ( string readingId, string accessToken = null ) : Task>
GetReadingPeriodsAsync ( string readingId, string accessToken = null ) : Task>
GetReadingSession ( string accessToken, string readingId ) : ReadingSession
GetReadingsAsync ( ReadingsQueryOptions options = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Retrieves a list of readings.
PostReadingCommentAsync ( string accessToken, string readingId, Comment comment ) : Task
PostReadingHighlightAsync ( string accessToken, string readingId, Highlight highlight ) : Task
PostReadingPingAsync ( string accessToken, string readingId, Ping ping ) : Task
ReadingsClient ( string clientId ) : System	Instantiates a client for the Readmill/Users api
UpdateReadingAsync ( string accessToken, string readingId, ReadingUpdategram updatedReading ) : Task

Protected Methods

Method	Description
LoadTemplates ( ) : void

Method Details

DeleteReadingAsync() public method

public DeleteReadingAsync ( string accessToken, string readingId ) : Task
accessToken	string
readingId	string
return	Task

GetReadingByIdAsync() public method

public GetReadingByIdAsync ( string readingId, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task
readingId	string
accessToken	string	(optional) for private readings
cancellationToken	System.Threading.CancellationToken
return	Task

GetReadingCommentsAsync() public method

public GetReadingCommentsAsync ( string readingId, RangeQueryOptions options = null, string accessToken = null ) : Task>
readingId	string
options	RangeQueryOptions
accessToken	string
return	Task>

GetReadingHighlightsAsync() public method

public GetReadingHighlightsAsync ( string readingId, RangeQueryOptions options = null, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
readingId	string
options	RangeQueryOptions
accessToken	string
cancellationToken	System.Threading.CancellationToken
return	Task>

GetReadingLocationsAsync() public method

public GetReadingLocationsAsync ( string readingId, string accessToken = null ) : Task>
readingId	string
accessToken	string
return	Task>

GetReadingPeriodsAsync() public method

public GetReadingPeriodsAsync ( string readingId, string accessToken = null ) : Task>
readingId	string
accessToken	string
return	Task>

GetReadingSession() public method

public GetReadingSession ( string accessToken, string readingId ) : ReadingSession
accessToken	string
readingId	string
return	ReadingSession

GetReadingsAsync() public method

Retrieves a list of readings.

public GetReadingsAsync ( ReadingsQueryOptions options = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
options	ReadingsQueryOptions	Query options for retrieving the readings (optional)
cancellationToken	System.Threading.CancellationToken
return	Task>

LoadTemplates() protected method

protected LoadTemplates ( ) : void
return	void

PostReadingCommentAsync() public method

public PostReadingCommentAsync ( string accessToken, string readingId, Comment comment ) : Task
accessToken	string
readingId	string
comment	Com.Readmill.Api.DataContracts.Comment
return	Task

PostReadingHighlightAsync() public method

public PostReadingHighlightAsync ( string accessToken, string readingId, Highlight highlight ) : Task
accessToken	string
readingId	string
highlight	Com.Readmill.Api.DataContracts.Highlight
return	Task

PostReadingPingAsync() public method

public PostReadingPingAsync ( string accessToken, string readingId, Ping ping ) : Task
accessToken	string
readingId	string
ping	Com.Readmill.Api.DataContracts.Ping
return	Task

ReadingsClient() public method

Instantiates a client for the Readmill/Users api

public ReadingsClient ( string clientId ) : System
clientId	string	Client Id of the application, assgined by Readmill when the app is registered
return	System

UpdateReadingAsync() public method

public UpdateReadingAsync ( string accessToken, string readingId, ReadingUpdategram updatedReading ) : Task
accessToken	string
readingId	string
updatedReading	Com.Readmill.Api.DataContracts.ReadingUpdategram
return	Task