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

Merge users More...

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

Public Member Functions

 MergeUsers (string targetUserId, string sourceUserId, bool?cascadeCreate=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 TargetUserId [get]
 ID of the targer user. More...
 
string SourceUserId [get]
 ID of the source user. More...
 
bool CascadeCreate [get]
 Sets whether the user targetUserId should be created if not present in the database. 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

Merge users

Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable. Merging happens between two users referred to as the target and the source. After the merge, all the interactions of the source user are attributed to the target user, and the source user is deleted.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.MergeUsers.MergeUsers ( string  targetUserId,
string  sourceUserId,
bool?  cascadeCreate = null 
)
inline

Construct the request

Parameters
targetUserIdID of the targer user.
sourceUserIdID of the source user.
cascadeCreateSets whether the user targetUserId should be created if not present in the database.

Member Function Documentation

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

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

Sets whether the user targetUserId should be created if not present in the database.

string Recombee.ApiClient.ApiRequests.MergeUsers.SourceUserId
get

ID of the source user.

string Recombee.ApiClient.ApiRequests.MergeUsers.TargetUserId
get

ID of the targer user.


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