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

Delete view portion More...

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

Public Member Functions

 DeleteViewPortion (string userId, string itemId, string sessionId=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...
 
string SessionId [get]
 Identifier of a session. 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 view portion

Deletes an existing view portion specified by (userId, itemId, sessionId) from the database.

Constructor & Destructor Documentation

◆ DeleteViewPortion()

Recombee.ApiClient.ApiRequests.DeleteViewPortion.DeleteViewPortion ( string  userId,
string  itemId,
string  sessionId = null 
)
inline

Construct the request

Parameters
userIdID of the user who rated the item.
itemIdID of the item which was rated.
sessionIdIdentifier of a session.

Member Function Documentation

◆ BodyParameters()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

ID of the item which was rated.

◆ SessionId

string Recombee.ApiClient.ApiRequests.DeleteViewPortion.SessionId
get

Identifier of a session.

◆ UserId

string Recombee.ApiClient.ApiRequests.DeleteViewPortion.UserId
get

ID of the user who rated the item.


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