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

Remove from series More...

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

Public Member Functions

 RemoveFromSeries (string seriesId, string itemType, string itemId, double time)
 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 from which a series item is to be removed. More...
 
string ItemType [get]
 Type of the item to be removed. 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 of the item to be removed. 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

Remove from series

Removes an existing series item from the series.

Constructor & Destructor Documentation

◆ RemoveFromSeries()

Recombee.ApiClient.ApiRequests.RemoveFromSeries.RemoveFromSeries ( string  seriesId,
string  itemType,
string  itemId,
double  time 
)
inline

Construct the request

Parameters
seriesIdID of the series from which a series item is to be removed.
itemTypeType of the item to be removed.
itemIdID of the item iff itemType is item. ID of the series iff itemType is series.
timeTime index of the item to be removed.

Member Function Documentation

◆ BodyParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.RemoveFromSeries.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.RemoveFromSeries.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

◆ ItemId

string Recombee.ApiClient.ApiRequests.RemoveFromSeries.ItemId
get

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

◆ ItemType

string Recombee.ApiClient.ApiRequests.RemoveFromSeries.ItemType
get

Type of the item to be removed.

◆ SeriesId

string Recombee.ApiClient.ApiRequests.RemoveFromSeries.SeriesId
get

ID of the series from which a series item is to be removed.

◆ Time

double Recombee.ApiClient.ApiRequests.RemoveFromSeries.Time
get

Time index of the item to be removed.


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