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

ViewPortion Binding More...

Inheritance diagram for Recombee.ApiClient.Bindings.ViewPortion:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.Bindings.ViewPortion:
Collaboration graph
[legend]

Public Member Functions

 ViewPortion (string userId, string itemId, double portion, string sessionId=null, DateTime?timestamp=null, string recommId=null)
 
override bool Equals (Object obj)
 Determines whether the specified object is equal to the current object More...
 
override int GetHashCode ()
 Hash function 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...
 
string RecommId [get]
 If this view portion is based on a recommendation request, recommId is the id of the clicked recommendation. More...
 

Detailed Description

ViewPortion Binding

Constructor & Destructor Documentation

Recombee.ApiClient.Bindings.ViewPortion.ViewPortion ( string  userId,
string  itemId,
double  portion,
string  sessionId = null,
DateTime?  timestamp = null,
string  recommId = null 
)
inline

Member Function Documentation

override bool Recombee.ApiClient.Bindings.ViewPortion.Equals ( Object  obj)
inline

Determines whether the specified object is equal to the current object

Parameters
objThe object to compare with the current object
Returns
true if the specified object is equal to the current object; otherwise, false
override int Recombee.ApiClient.Bindings.ViewPortion.GetHashCode ( )
inline

Hash function

Returns
A hash code for the current object

Property Documentation

string Recombee.ApiClient.Bindings.ViewPortion.ItemId
get

Viewed item

double Recombee.ApiClient.Bindings.ViewPortion.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.Bindings.ViewPortion.RecommId
get

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

string Recombee.ApiClient.Bindings.ViewPortion.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.Bindings.ViewPortion.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.Bindings.ViewPortion.UserId
get

User who viewed a portion of the item


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