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

Наследование: ReadmillClientBase

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

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

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

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

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

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

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

public DeleteHighlightAsync ( string accessToken, string highlightId ) : Task
accessToken	string
highlightId	string
Результат	Task

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

public GetHighlightByIdAsync ( string highlightId, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task
highlightId	string
accessToken	string	(optional) for private highlights
cancellationToken	System.Threading.CancellationToken
Результат	Task

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

public GetHighlightCommentsAsync ( string highlightId, RangeQueryOptions options = null, string accessToken = null ) : Task>
highlightId	string
options	RangeQueryOptions
accessToken	string
Результат	Task>

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

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

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

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

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

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

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

public PostHighlightCommentAsync ( string accessToken, string highlightId, Comment comment ) : Task
accessToken	string
highlightId	string
comment	Com.Readmill.Api.DataContracts.Comment
Результат	Task

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

public UpdateHighlightAsync ( string accessToken, string highlightId, Highlight updatedHighlight ) : Task
accessToken	string
highlightId	string
updatedHighlight	Com.Readmill.Api.DataContracts.Highlight
Результат	Task