Add user property More...
Inheritance diagram for Recombee.ApiClient.ApiRequests.AddUserProperty:
Collaboration diagram for Recombee.ApiClient.ApiRequests.AddUserProperty:
Public Member Functions | |
| AddUserProperty (string propertyName, string type) | |
| Construct the request More... | |
| override string | Path () |
| |
| 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 | PropertyName [get] |
Name of the user property to be created. Currently, the following names are reserved:id, userid, case insensitively. Also, the length of the property name must not exceed 63 characters. More... | |
| string | Type [get] |
Value type of the user property to be created. One of: int, double, string, boolean, timestamp, set. 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) |
| |
Detailed Description
Add user property
Adding an user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
Constructor & Destructor Documentation
◆ AddUserProperty()
|
inline |
Construct the request
- Parameters
-
propertyName Name of the user property to be created. Currently, the following names are reserved: id,userid, case insensitively. Also, the length of the property name must not exceed 63 characters.type Value type of the user property to be created. One of: int,double,string,boolean,timestamp,set.int- Signed integer number.double- Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).string- UTF-8 string.boolean- true / falsetimestamp- Value representing date and time.set- Set of strings.
Member Function Documentation
◆ 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()
|
inlinevirtual |
- Returns
- URI to the endpoint including path parameters
Implements Recombee.ApiClient.ApiRequests.Request.
◆ 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
◆ PropertyName
|
get |
Name of the user property to be created. Currently, the following names are reserved:id, userid, case insensitively. Also, the length of the property name must not exceed 63 characters.
◆ Type
|
get |
Value type of the user property to be created. One of: int, double, string, boolean, timestamp, set.
int- Signed integer number.double- Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).string- UTF-8 string.boolean- true / falsetimestamp- Value representing date and time.set- Set of strings.
The documentation for this class was generated from the following file:
- Src/Recombee.ApiClient/ApiRequests/AddUserProperty.cs
