C# Class Com.Readmill.Api.HighlightsClient

Inheritance: ReadmillClientBase

Mostra file Open project: totobogy/ReadmillDotNet

Public Methods

Method	Description
DeleteHighlightAsync ( string accessToken, string highlightId ) : Task
GetHighlightByIdAsync ( string highlightId, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task
GetHighlightCommentsAsync ( string highlightId, RangeQueryOptions options = null, string accessToken = null ) : Task>
GetHighlightsAsync ( RangeQueryOptions options = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>	Retrieves a list of highlights.
HighlightsClient ( string clientId ) : System	Instantiates a client for the Readmill/Users api
PostHighlightCommentAsync ( string accessToken, string highlightId, Comment comment ) : Task
UpdateHighlightAsync ( string accessToken, string highlightId, Highlight updatedHighlight ) : Task

Protected Methods

Method	Description
LoadTemplates ( ) : void

Method Details

DeleteHighlightAsync() public method

public DeleteHighlightAsync ( string accessToken, string highlightId ) : Task
accessToken	string
highlightId	string
return	Task

GetHighlightByIdAsync() public method

public GetHighlightByIdAsync ( string highlightId, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task
highlightId	string
accessToken	string	(optional) for private highlights
cancellationToken	System.Threading.CancellationToken
return	Task

GetHighlightCommentsAsync() public method

public GetHighlightCommentsAsync ( string highlightId, RangeQueryOptions options = null, string accessToken = null ) : Task>
highlightId	string
options	RangeQueryOptions
accessToken	string
return	Task>

GetHighlightsAsync() public method

Retrieves a list of highlights.

public GetHighlightsAsync ( RangeQueryOptions options = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
options	RangeQueryOptions	Query options for retrieving the highlights (optional)
cancellationToken	System.Threading.CancellationToken
return	Task>

HighlightsClient() public method

Instantiates a client for the Readmill/Users api

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

LoadTemplates() protected method

protected LoadTemplates ( ) : void
return	void

PostHighlightCommentAsync() public method

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

UpdateHighlightAsync() public method

public UpdateHighlightAsync ( string accessToken, string highlightId, Highlight updatedHighlight ) : Task
accessToken	string
highlightId	string
updatedHighlight	Com.Readmill.Api.DataContracts.Highlight
return	Task