Oddity.Endpoints.PayloadsEndpoint< TData > Class Template Reference

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

Inheritance diagram for Oddity.Endpoints.PayloadsEndpoint< TData >:

Public Member Functions
	PayloadsEndpoint (OddityCore context)
	Initializes a new instance of the PayloadsEndpoint<TData> class. More...
SimpleBuilder< TData >	Get (string id)
	Gets data about the specified payload from the /payloads/:id endpoint. More...
ListBuilder< TData >	GetAll ()
	Gets data about all payloads from the /payloads endpoint. More...
QueryBuilder< TData >	Query ()
	Gets filtered and paginated data about all payloads from the /payloads/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 /payloads endpoint.

Template Parameters

TData

Type of the data returned from API.

Type Constraints

TData	:	ModelBase
TData	:	IIdentifiable
TData	:	new()

Constructor & Destructor Documentation

Oddity.Endpoints.PayloadsEndpoint< TData >.PayloadsEndpoint

(

OddityCore

context

)

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

Parameters

context

The Oddity context used to interact with API.

Member Function Documentation

SimpleBuilder<TData> Oddity.Endpoints.PayloadsEndpoint< TData >.Get

(

string

id

)

Gets data about the specified payload from the /payloads/:id endpoint.

Parameters

id	ID of the specified payload.

Returns

Deserialized JSON returned from the API.

ListBuilder<TData> Oddity.Endpoints.PayloadsEndpoint< TData >.GetAll

(

)

Gets data about all payloads from the /payloads endpoint.

Returns

Deserialized JSON returned from the API.

QueryBuilder<TData> Oddity.Endpoints.PayloadsEndpoint< TData >.Query

(

)

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

Returns

Deserialized JSON returned from the API.

---

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

• Oddity/Endpoints/PayloadsEndpoint.cs