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

Add bookmark More...

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

Public Member Functions

 AddBookmark (string userId, string itemId, DateTime? timestamp=null, bool? cascadeCreate=null, string recommId=null, Dictionary< string, object > additionalData=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 bookmarked the item More...
 
string ItemId [get]
 Bookmarked item More...
 
DateTime? Timestamp [get]
 UTC timestamp of the bookmark 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 bookmark is based on a recommendation request, recommId is the id of the clicked recommendation. More...
 
Dictionary< string, object > AdditionalData [get]
 A dictionary of additional data for the interaction. 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 bookmark

Adds a bookmark of a given item made by a given user.

Constructor & Destructor Documentation

◆ AddBookmark()

Recombee.ApiClient.ApiRequests.AddBookmark.AddBookmark ( string  userId,
string  itemId,
DateTime?  timestamp = null,
bool?  cascadeCreate = null,
string  recommId = null,
Dictionary< string, object >  additionalData = null 
)
inline

Construct the request

Parameters
userIdUser who bookmarked the item
itemIdBookmarked item
timestampUTC timestamp of the bookmark 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 bookmark is based on a recommendation request, recommId is the id of the clicked recommendation.
additionalDataA dictionary of additional data for the interaction.

Member Function Documentation

◆ BodyParameters()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

◆ AdditionalData

Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddBookmark.AdditionalData
get

A dictionary of additional data for the interaction.

◆ CascadeCreate

bool? Recombee.ApiClient.ApiRequests.AddBookmark.CascadeCreate
get

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

◆ ItemId

string Recombee.ApiClient.ApiRequests.AddBookmark.ItemId
get

Bookmarked item

◆ RecommId

string Recombee.ApiClient.ApiRequests.AddBookmark.RecommId
get

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

◆ Timestamp

DateTime? Recombee.ApiClient.ApiRequests.AddBookmark.Timestamp
get

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

◆ UserId

string Recombee.ApiClient.ApiRequests.AddBookmark.UserId
get

User who bookmarked the item


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