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

Delete more items More...

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

Public Member Functions

 DeleteMoreItems (string filter)
 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 Filter [get]
 A ReQL expression, which return true for the items that shall be updated. 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

Delete more items

Delete all the items that pass the filter. If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and only exclude the item from recommendations. In such a case, use ReQL filter instead of deleting the item completely.

Constructor & Destructor Documentation

◆ DeleteMoreItems()

Recombee.ApiClient.ApiRequests.DeleteMoreItems.DeleteMoreItems ( string  filter)
inline

Construct the request

Parameters
filterA ReQL expression, which return true for the items that shall be updated.

Member Function Documentation

◆ BodyParameters()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

◆ Filter

string Recombee.ApiClient.ApiRequests.DeleteMoreItems.Filter
get

A ReQL expression, which return true for the items that shall be updated.


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