C# Class Com.Readmill.Api.UsersClient

Inheritance: ReadmillClientBase
Show file Open project: totobogy/ReadmillDotNet

Public Methods

Method Description
GetOwnerAsync ( string accessToken ) : Task

Retrieves the representation of the user corresponding to the authentication token.

GetUserByIdAsync ( string userId ) : Task

Retrieves the representation of a single user by id

GetUserReadings ( string userId, ReadingsQueryOptions options = null, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>

Retrieves a list of readings corresponding to the user with the specified ID.

UsersClient ( string clientId ) : System

Instantiates a client for the Readmill/Users api

Protected Methods

Method Description
LoadTemplates ( ) : void

Method Details

GetOwnerAsync() public method

Retrieves the representation of the user corresponding to the authentication token.
public GetOwnerAsync ( string accessToken ) : Task
accessToken string authentication token
return Task

GetUserByIdAsync() public method

Retrieves the representation of a single user by id
public GetUserByIdAsync ( string userId ) : Task
userId string The Readmill user-id of the user you want to retrieve.
return Task

GetUserReadings() public method

Retrieves a list of readings corresponding to the user with the specified ID.
public GetUserReadings ( string userId, ReadingsQueryOptions options = null, string accessToken = null, CancellationToken cancellationToken = default(CancellationToken) ) : Task>
userId string Readmill user-id of the user whose readings you want to retrieve
options ReadingsQueryOptions Query options for retrieving the readings
accessToken string
cancellationToken System.Threading.CancellationToken
return Task>

LoadTemplates() protected method

protected LoadTemplates ( ) : void
return void

UsersClient() public method

Instantiates a client for the Readmill/Users api
public UsersClient ( string clientId ) : System
clientId string Client Id of the application, assgined by Readmill when the app is registered
return System