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

Insert to group More...

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

Public Member Functions

 InsertToGroup (string groupId, string itemType, string itemId, 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 GroupId [get]
 ID of the group to be inserted into. More...
 
string ItemType [get]
 item iff the regular item from the catalog is to be inserted, group iff group is inserted as the item. More...
 
string ItemId [get]
 ID of the item iff itemType is item. ID of the group iff itemType is group. More...
 
bool? CascadeCreate [get]
 Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the groupId and the groupId. If cascadeCreate is set true, the behavior also depends on the itemType. Either items or group may 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

Insert to group

Inserts an existing item/group into group of given groupId.

Constructor & Destructor Documentation

◆ InsertToGroup()

Recombee.ApiClient.ApiRequests.InsertToGroup.InsertToGroup ( string  groupId,
string  itemType,
string  itemId,
bool?  cascadeCreate = null 
)
inline

Construct the request

Parameters
groupIdID of the group to be inserted into.
itemTypeitem iff the regular item from the catalog is to be inserted, group iff group is inserted as the item.
itemIdID of the item iff itemType is item. ID of the group iff itemType is group.
cascadeCreateIndicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the groupId and the groupId. If cascadeCreate is set true, the behavior also depends on the itemType. Either items or group may be created if not present in the database.

Member Function Documentation

◆ BodyParameters()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

◆ CascadeCreate

bool? Recombee.ApiClient.ApiRequests.InsertToGroup.CascadeCreate
get

Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the groupId and the groupId. If cascadeCreate is set true, the behavior also depends on the itemType. Either items or group may be created if not present in the database.

◆ GroupId

string Recombee.ApiClient.ApiRequests.InsertToGroup.GroupId
get

ID of the group to be inserted into.

◆ ItemId

string Recombee.ApiClient.ApiRequests.InsertToGroup.ItemId
get

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

◆ ItemType

string Recombee.ApiClient.ApiRequests.InsertToGroup.ItemType
get

item iff the regular item from the catalog is to be inserted, group iff group is inserted as the item.


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