C# 클래스 Com.Readmill.Api.HighlightsClient

상속: ReadmillClientBase

파일 보기 프로젝트 열기: totobogy/ReadmillDotNet

공개 메소드들

메소드	설명
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