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

Set/update (some) property values of a given user More...

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

Public Member Functions

 SetUserValues (string userId, Dictionary< string, object > values, bool?cascadeCreate=null)
 Construct the request More...
 
override string Path ()
 
Returns
URI to the endpoint including path parameters
More...
 
- Public Member Functions inherited from Recombee.ApiClient.ApiRequests.SetValues
 SetValues (Dictionary< string, object > values, bool?cascadeCreate=null)
 Construct the request 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]
 ID of the user which will be modified. More...
 
- Properties inherited from Recombee.ApiClient.ApiRequests.SetValues
bool CascadeCreate [get]
 Sets whether the entity should be created if not present in the database. More...
 
Dictionary< string, object > Values [get]
 The values for the individual properties. 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/update (some) property values of a given user

The properties (columns) must be previously created by Add user property(https://docs.recombee.com/api.html#add-user-property).

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.SetUserValues.SetUserValues ( string  userId,
Dictionary< string, object >  values,
bool?  cascadeCreate = null 
)
inline

Construct the request

Parameters
userIdID of the user which will be modified.
valuesThe values for the individual properties. Key in the Dictionary is the name of the property and value is the value to be set.
cascadeCreateSets whether the user should be created if not present in the database.

Member Function Documentation

override string Recombee.ApiClient.ApiRequests.SetUserValues.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

string Recombee.ApiClient.ApiRequests.SetUserValues.UserId
get

ID of the user which will be modified.


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