Recombee API client
Back to top  

GetUserPropertyInfo

Extends \Recombee\RecommApi\Requests\Request

Gets information about specified user property.

package

Default

Methods

Construct the request

__construct(string $property_name)

Arguments

$property_name

string

Name of the property about which the information is to be retrieved.

Get body parameters

getBodyParameters() : array
inherited abstract

Response

array

Values of body parameters (name of parameter => value of the parameter)

Returns true if HTTPS must be chosen over HTTP for this request

getEnsureHttps() : boolean
inherited

Response

boolean

true if HTTPS must be chosen

Get used HTTP method

getMethod() : static
inherited abstract

Response

static

Used HTTP method

Get URI to the endpoint

getPath() : string
inherited abstract

Response

string

URI to the endpoint

Get query parameters

getQueryParameters() : array
inherited abstract

Response

array

Values of query parameters (name of parameter => value of the parameter)

Get request timeout

getTimeout() : integer
inherited

Response

integer

Request timeout in milliseconds

Sets if HTTPS must be chosen over HTTP for this request

setEnsureHttps( $ensure_https)
inherited

Arguments

$ensure_https

Sets request timeout

setTimeout( $timeout)
inherited

Arguments

$timeout

Properties

Name of the property about which the information is to be retrieved.

property_name : string
var

Name of the property about which the information is to be retrieved.

Type(s)

string

Timeout of the request in milliseconds

timeout : integer
inherited
var

Timeout of the request in milliseconds

Type(s)

integer

Sets if the HTTPS must be chosen over HTTP for this request

ensure_https : boolean
inherited
var

Sets if the HTTPS must be chosen over HTTP for this request

Type(s)

boolean