Recombee API Client
Public Member Functions | Properties | List of all members
Recombee.ApiClient.ApiRequests.ListSeriesItems Class Reference

List series items More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.ListSeriesItems:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.ApiRequests.ListSeriesItems:
Collaboration graph
[legend]

Public Member Functions

 ListSeriesItems (string seriesId)
 Construct the request More...
 
override string Path ()
 
Returns
URI to the endpoint including path parameters
More...
 
override Dictionary< string, object > QueryParameters ()
 Get query parameters More...
 
override Dictionary< string, object > BodyParameters ()
 Get body parameters More...
 
- Public Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
 Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false)
 Construct the request More...
 

Properties

string SeriesId [get]
 ID of the series items of which are to be listed. More...
 
- Properties inherited from Recombee.ApiClient.ApiRequests.Request
TimeSpan Timeout [get, set]
 Timeout for the request in milliseconds More...
 
bool EnsureHttps [get]
 If true, HTTPS must be chosen over HTTP for this request More...
 
HttpMethod RequestHttpMehod [get]
 Used HTTP method More...
 

Additional Inherited Members

- Protected Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
double ConvertToUnixTimestamp (DateTime date)
 
Returns
Converts DateTime to UNIX timestamp (epoch)
More...
 

Detailed Description

List series items

List all the items present in the given series, sorted according to their time index values.

Constructor & Destructor Documentation

◆ ListSeriesItems()

Recombee.ApiClient.ApiRequests.ListSeriesItems.ListSeriesItems ( string  seriesId)
inline

Construct the request

Parameters
seriesIdID of the series items of which are to be listed.

Member Function Documentation

◆ BodyParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.ListSeriesItems.BodyParameters ( )
inlinevirtual

Get body parameters

Returns
Dictionary containing values of body parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

◆ Path()

override string Recombee.ApiClient.ApiRequests.ListSeriesItems.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.ListSeriesItems.QueryParameters ( )
inlinevirtual

Get query parameters

Returns
Dictionary containing values of query parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

◆ SeriesId

string Recombee.ApiClient.ApiRequests.ListSeriesItems.SeriesId
get

ID of the series items of which are to be listed.


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