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

List search synonyms More...

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

Public Member Functions

 ListSearchSynonyms (long? count=null, long? offset=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

long? Count [get]
 The number of synonyms to be listed. More...
 
long? Offset [get]
 Specifies the number of synonyms to skip (ordered by term). 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

List search synonyms

Gives the list of synonyms defined in the database.

Constructor & Destructor Documentation

◆ ListSearchSynonyms()

Recombee.ApiClient.ApiRequests.ListSearchSynonyms.ListSearchSynonyms ( long?  count = null,
long?  offset = null 
)
inline

Construct the request

Parameters
countThe number of synonyms to be listed.
offsetSpecifies the number of synonyms to skip (ordered by term).

Member Function Documentation

◆ BodyParameters()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

◆ Count

long? Recombee.ApiClient.ApiRequests.ListSearchSynonyms.Count
get

The number of synonyms to be listed.

◆ Offset

long? Recombee.ApiClient.ApiRequests.ListSearchSynonyms.Offset
get

Specifies the number of synonyms to skip (ordered by term).


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