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

Insert to series More...

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

Public Member Functions

 InsertToSeries (string seriesId, string itemType, string itemId, double time, bool?cascadeCreate=null)
 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 to be inserted into. More...
 
string ItemType [get]
 item iff the regular item from the catalog is to be inserted, series iff series is inserted as the item. More...
 
string ItemId [get]
 ID of the item iff itemType is item. ID of the series iff itemType is series. More...
 
double Time [get]
 Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time. More...
 
bool CascadeCreate [get]
 Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the seriesId and the itemId. If cascadeCreate is set true, the behavior also depends on the itemType. Either item or series may be created if not present in the database. 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

Insert to series

Inserts an existing item/series into series of given seriesId at position determined by time.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.InsertToSeries.InsertToSeries ( string  seriesId,
string  itemType,
string  itemId,
double  time,
bool?  cascadeCreate = null 
)
inline

Construct the request

Parameters
seriesIdID of the series to be inserted into.
itemTypeitem iff the regular item from the catalog is to be inserted, series iff series is inserted as the item.
itemIdID of the item iff itemType is item. ID of the series iff itemType is series.
timeTime index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.
cascadeCreateIndicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the seriesId and the itemId. If cascadeCreate is set true, the behavior also depends on the itemType. Either item or series may be created if not present in the database.

Member Function Documentation

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

Get body parameters

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

Implements Recombee.ApiClient.ApiRequests.Request.

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.InsertToSeries.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

bool Recombee.ApiClient.ApiRequests.InsertToSeries.CascadeCreate
get

Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the seriesId and the itemId. If cascadeCreate is set true, the behavior also depends on the itemType. Either item or series may be created if not present in the database.

string Recombee.ApiClient.ApiRequests.InsertToSeries.ItemId
get

ID of the item iff itemType is item. ID of the series iff itemType is series.

string Recombee.ApiClient.ApiRequests.InsertToSeries.ItemType
get

item iff the regular item from the catalog is to be inserted, series iff series is inserted as the item.

string Recombee.ApiClient.ApiRequests.InsertToSeries.SeriesId
get

ID of the series to be inserted into.

double Recombee.ApiClient.ApiRequests.InsertToSeries.Time
get

Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.


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