Recombee.ApiClient.ApiRequests.DeleteRating Class Reference

Delete rating More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.DeleteRating:

Collaboration diagram for Recombee.ApiClient.ApiRequests.DeleteRating:

Public Member Functions
	DeleteRating (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 rated the item. More...
string	ItemId [get]
	ID of the item which was rated. More...
DateTime?	Timestamp [get]
	Unix timestamp of the rating. If the timestamp is omitted, then all the ratings 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 rating

Deletes an existing rating specified by (userId, itemId, timestamp) from the database or all the ratings with given userId and itemId if timestamp is omitted.

Constructor & Destructor Documentation

DeleteRating()

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

inline

Construct the request

Parameters

userId	ID of the user who rated the item.
itemId	ID of the item which was rated.
timestamp	Unix timestamp of the rating. If the timestamp is omitted, then all the ratings with given userId and itemId are deleted.

Member Function Documentation

BodyParameters()

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

inlinevirtual

Returns

URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

QueryParameters()

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

get

ID of the item which was rated.

Timestamp

DateTime? Recombee.ApiClient.ApiRequests.DeleteRating.Timestamp

get

Unix timestamp of the rating. If the timestamp is omitted, then all the ratings with given userId and itemId are deleted.

UserId

string Recombee.ApiClient.ApiRequests.DeleteRating.UserId

get

ID of the user who rated the item.

---

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

• Src/Recombee.ApiClient/ApiRequests/DeleteRating.cs