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

Add detail view More...

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

Public Member Functions

 AddDetailView (string userId, string itemId, DateTime?timestamp=null, long?duration=null, bool?cascadeCreate=null, string recommId=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]
 User who viewed the item More...
 
string ItemId [get]
 Viewed item More...
 
DateTime Timestamp [get]
 UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time. More...
 
long Duration [get]
 Duration of the view More...
 
bool CascadeCreate [get]
 Sets whether the given user/item should be created if not present in the database. More...
 
string RecommId [get]
 If this detail view is based on a recommendation request, recommId is the id of the clicked recommendation. 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

Add detail view

Adds a detail view of a given item made by a given user.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.AddDetailView.AddDetailView ( string  userId,
string  itemId,
DateTime?  timestamp = null,
long?  duration = null,
bool?  cascadeCreate = null,
string  recommId = null 
)
inline

Construct the request

Parameters
userIdUser who viewed the item
itemIdViewed item
timestampUTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
durationDuration of the view
cascadeCreateSets whether the given user/item should be created if not present in the database.
recommIdIf this detail view is based on a recommendation request, recommId is the id of the clicked recommendation.

Member Function Documentation

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

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

bool Recombee.ApiClient.ApiRequests.AddDetailView.CascadeCreate
get

Sets whether the given user/item should be created if not present in the database.

long Recombee.ApiClient.ApiRequests.AddDetailView.Duration
get

Duration of the view

string Recombee.ApiClient.ApiRequests.AddDetailView.ItemId
get

Viewed item

string Recombee.ApiClient.ApiRequests.AddDetailView.RecommId
get

If this detail view is based on a recommendation request, recommId is the id of the clicked recommendation.

DateTime Recombee.ApiClient.ApiRequests.AddDetailView.Timestamp
get

UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

string Recombee.ApiClient.ApiRequests.AddDetailView.UserId
get

User who viewed the item


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