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

Remove from group More...

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

Public Member Functions

 RemoveFromGroup (string groupId, string itemType, string itemId)
 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 from which a group item is to be removed. More...
 
string ItemType [get]
 Type of the item to be removed. More...
 
string ItemId [get]
 ID of the item iff itemType is item. ID of the group iff itemType is group. 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

Remove from group

Removes an existing group item from the group.

Constructor & Destructor Documentation

◆ RemoveFromGroup()

Recombee.ApiClient.ApiRequests.RemoveFromGroup.RemoveFromGroup ( string  groupId,
string  itemType,
string  itemId 
)
inline

Construct the request

Parameters
groupIdID of the group from which a group item is to be removed.
itemTypeType of the item to be removed.
itemIdID of the item iff itemType is item. ID of the group iff itemType is group.

Member Function Documentation

◆ BodyParameters()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

◆ GroupId

string Recombee.ApiClient.ApiRequests.RemoveFromGroup.GroupId
get

ID of the group from which a group item is to be removed.

◆ ItemId

string Recombee.ApiClient.ApiRequests.RemoveFromGroup.ItemId
get

ID of the item iff itemType is item. ID of the group iff itemType is group.

◆ ItemType

string Recombee.ApiClient.ApiRequests.RemoveFromGroup.ItemType
get

Type of the item to be removed.


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