Oddity
Oddity.Endpoints.CrewEndpoint< TData > Class Template Reference

Represents an entry point of /crew endpoint. More...

Inheritance diagram for Oddity.Endpoints.CrewEndpoint< TData >:
Oddity.Endpoints.EndpointBase< TData >

Public Member Functions

 CrewEndpoint (OddityCore context)
 Initializes a new instance of the CrewEndpoint<TData> class. More...
 
SimpleBuilder< TData > Get (string id)
 Gets data about the specified crew member from the /crew/:id endpoint. More...
 
ListBuilder< TData > GetAll ()
 Gets data about crew from the /crew endpoint. More...
 
QueryBuilder< TData > Query ()
 Gets filtered and paginated data about crew from the /crew/query endpoint. More...
 
- Public Member Functions inherited from Oddity.Endpoints.EndpointBase< TData >
int ClearCache ()
 Clears all cached data. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Oddity.Endpoints.EndpointBase< TData >
 EndpointBase (OddityCore context, int cacheLifetime)
 Initializes a new instance of the EndpointBase<TData> class. More...
 
- Protected Attributes inherited from Oddity.Endpoints.EndpointBase< TData >
readonly OddityCore Context
 
readonly CacheService< TData > Cache
 

Detailed Description

Represents an entry point of /crew endpoint.

Template Parameters
TDataType of the data returned from API.
Type Constraints
TData :ModelBase 
TData :IIdentifiable 
TData :new() 

Constructor & Destructor Documentation

Initializes a new instance of the CrewEndpoint<TData> class.

Parameters
contextThe Oddity context used to interact with API.

Member Function Documentation

SimpleBuilder<TData> Oddity.Endpoints.CrewEndpoint< TData >.Get ( string  id)

Gets data about the specified crew member from the /crew/:id endpoint.

Parameters
idID of the specified crew member.
Returns
Deserialized JSON returned from the API.
ListBuilder<TData> Oddity.Endpoints.CrewEndpoint< TData >.GetAll ( )

Gets data about crew from the /crew endpoint.

Returns
Deserialized JSON returned from the API.
QueryBuilder<TData> Oddity.Endpoints.CrewEndpoint< TData >.Query ( )

Gets filtered and paginated data about crew from the /crew/query endpoint.

Returns
Deserialized JSON returned from the API.

The documentation for this class was generated from the following file: