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

Delete group More...

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

Public Member Functions

 DeleteGroup (string groupId)
 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 GroupId [get]
 ID of the group to be deleted. 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 group

Deletes the group of given groupId from the database. Deleting a group will only delete assignment of items to it, not the items themselves!

Constructor & Destructor Documentation

Recombee.ApiClient.ApiRequests.DeleteGroup.DeleteGroup ( string  groupId)
inline

Construct the request

Parameters
groupIdID of the group to be deleted.

Member Function Documentation

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

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

ID of the group to be deleted.


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