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

Delete user More...

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

Public Member Functions

 DeleteUser (string userId)
 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]
 ID of the user to be added. 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

Delete user

Deletes a user of given userId from the database. If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.DeleteUser.DeleteUser ( string  userId)
inline

Construct the request

Parameters
userIdID of the user to be added.

Member Function Documentation

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

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

string Recombee.ApiClient.ApiRequests.DeleteUser.UserId
get

ID of the user to be added.


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