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

List users More...

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

Public Member Functions

 ListUsers (string filter=null, long? count=null, long? offset=null, bool? returnProperties=null, string[] includedProperties=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 Filter [get]
 Boolean-returning ReQL expression, which allows you to filter users to be listed. Only the users for which the expression is true will be returned. More...
 
long? Count [get]
 The number of users to be listed. More...
 
long? Offset [get]
 Specifies the number of users to skip (ordered by userId). More...
 
bool? ReturnProperties [get]
 With returnProperties=true, property values of the listed users are returned along with their IDs in a JSON dictionary. Example response: More...
 
string[] IncludedProperties [get]
 Allows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=country: 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 users

Gets a list of IDs of users currently present in the catalog.

Constructor & Destructor Documentation

◆ ListUsers()

Recombee.ApiClient.ApiRequests.ListUsers.ListUsers ( string  filter = null,
long?  count = null,
long?  offset = null,
bool?  returnProperties = null,
string[]  includedProperties = null 
)
inline

Construct the request

Parameters
filterBoolean-returning ReQL expression, which allows you to filter users to be listed. Only the users for which the expression is true will be returned.
countThe number of users to be listed.
offsetSpecifies the number of users to skip (ordered by userId).
returnPropertiesWith returnProperties=true, property values of the listed users are returned along with their IDs in a JSON dictionary. Example response:
[
{
"userId": "user-81",
"country": "US",
"sex": "M"
},
{
"userId": "user-314",
"country": "CAN",
"sex": "F"
}
]
Parameters
includedPropertiesAllows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=country:
[
{
"userId": "user-81",
"country": "US"
},
{
"userId": "user-314",
"country": "CAN"
}
]

Member Function Documentation

◆ BodyParameters()

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

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

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

The number of users to be listed.

◆ Filter

string Recombee.ApiClient.ApiRequests.ListUsers.Filter
get

Boolean-returning ReQL expression, which allows you to filter users to be listed. Only the users for which the expression is true will be returned.

◆ IncludedProperties

string [] Recombee.ApiClient.ApiRequests.ListUsers.IncludedProperties
get

Allows to specify, which properties should be returned when returnProperties=true is set. The properties are given as a comma-separated list. Example response for includedProperties=country:

[
{
"userId": "user-81",
"country": "US"
},
{
"userId": "user-314",
"country": "CAN"
}
]

◆ Offset

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

Specifies the number of users to skip (ordered by userId).

◆ ReturnProperties

bool? Recombee.ApiClient.ApiRequests.ListUsers.ReturnProperties
get

With returnProperties=true, property values of the listed users are returned along with their IDs in a JSON dictionary. Example response:

[
{
"userId": "user-81",
"country": "US",
"sex": "M"
},
{
"userId": "user-314",
"country": "CAN",
"sex": "F"
}
]

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