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

Set view portion More...

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

Public Member Functions

 SetViewPortion (string userId, string itemId, double portion, string sessionId=null, DateTime?timestamp=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 a portion of the item More...
 
string ItemId [get]
 Viewed item More...
 
double Portion [get]
 Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the really viewed part of the item, no matter seeking, so for example if the user seeked immediately to half of the item and then viewed 10% of the item, the portion should still be 0.1. More...
 
string SessionId [get]
 ID of session in which the user viewed the item. Default is null (None, nil, NULL etc. depending on language). More...
 
DateTime Timestamp [get]
 UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time. 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 view portion 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

Set view portion

Sets viewed portion of an item (for example a video or article) by a user (at a session). If you send new request with the same (userId, itemId, sessionId), the portion gets updated.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.SetViewPortion.SetViewPortion ( string  userId,
string  itemId,
double  portion,
string  sessionId = null,
DateTime?  timestamp = null,
bool?  cascadeCreate = null,
string  recommId = null 
)
inline

Construct the request

Parameters
userIdUser who viewed a portion of the item
itemIdViewed item
portionViewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the really viewed part of the item, no matter seeking, so for example if the user seeked immediately to half of the item and then viewed 10% of the item, the portion should still be 0.1.
sessionIdID of session in which the user viewed the item. Default is null (None, nil, NULL etc. depending on language).
timestampUTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
cascadeCreateSets whether the given user/item should be created if not present in the database.
recommIdIf this view portion is based on a recommendation request, recommId is the id of the clicked recommendation.

Member Function Documentation

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

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

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

string Recombee.ApiClient.ApiRequests.SetViewPortion.ItemId
get

Viewed item

double Recombee.ApiClient.ApiRequests.SetViewPortion.Portion
get

Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the really viewed part of the item, no matter seeking, so for example if the user seeked immediately to half of the item and then viewed 10% of the item, the portion should still be 0.1.

string Recombee.ApiClient.ApiRequests.SetViewPortion.RecommId
get

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

string Recombee.ApiClient.ApiRequests.SetViewPortion.SessionId
get

ID of session in which the user viewed the item. Default is null (None, nil, NULL etc. depending on language).

DateTime Recombee.ApiClient.ApiRequests.SetViewPortion.Timestamp
get

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

string Recombee.ApiClient.ApiRequests.SetViewPortion.UserId
get

User who viewed a portion of the item


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