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

Delete detail view More...

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

Public Member Functions

 DeleteDetailView (string userId, string itemId, DateTime?timestamp=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 UserId [get]
 ID of the user who made the detail view. More...
 
string ItemId [get]
 ID of the item of which the details were viewed. More...
 
DateTime Timestamp [get]
 Unix timestamp of the detail view. If the timestamp is omitted, then all the detail views with given userId and itemId are deleted. 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 detail view

Deletes an existing detail view uniquely specified by (userId, itemId, and timestamp) or all the detail views with given userId and itemId if timestamp is omitted.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.DeleteDetailView.DeleteDetailView ( string  userId,
string  itemId,
DateTime?  timestamp = null 
)
inline

Construct the request

Parameters
userIdID of the user who made the detail view.
itemIdID of the item of which the details were viewed.
timestampUnix timestamp of the detail view. If the timestamp is omitted, then all the detail views with given userId and itemId are deleted.

Member Function Documentation

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

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

string Recombee.ApiClient.ApiRequests.DeleteDetailView.ItemId
get

ID of the item of which the details were viewed.

DateTime Recombee.ApiClient.ApiRequests.DeleteDetailView.Timestamp
get

Unix timestamp of the detail view. If the timestamp is omitted, then all the detail views with given userId and itemId are deleted.

string Recombee.ApiClient.ApiRequests.DeleteDetailView.UserId
get

ID of the user who made the detail view.


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