Recombee API client

RemoveFromSeries extends Request

Removes an existing series item from the series.

Table of Contents

$ensure_https  : bool
$item_id  : string
$item_type  : string
$series_id  : string
$time  : float
$timeout  : int
__construct()  : mixed
Construct the request
getBodyParameters()  : array<string|int, mixed>
Get body parameters
getEnsureHttps()  : bool
Returns true if HTTPS must be chosen over HTTP for this request
getMethod()  : static
Get used HTTP method
getPath()  : string
Get URI to the endpoint
getQueryParameters()  : array<string|int, mixed>
Get query parameters
getTimeout()  : int
Get request timeout
setEnsureHttps()  : mixed
Sets if HTTPS must be chosen over HTTP for this request
setTimeout()  : mixed
Sets request timeout

Properties

$ensure_https

protected bool $ensure_https

Methods

__construct()

Construct the request

public __construct(string $series_id, string $item_type, string $item_id, float $time) : mixed
Parameters
$series_id : string

ID of the series from which a series item is to be removed.

$item_type : string

Type of the item to be removed.

$item_id : string

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

$time : float

Time index of the item to be removed.

Return values
mixed —

getBodyParameters()

Get body parameters

public getBodyParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

getEnsureHttps()

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

public getEnsureHttps() : bool
Return values
bool —

true if HTTPS must be chosen

getMethod()

Get used HTTP method

public getMethod() : static
Return values
static —

Used HTTP method

getPath()

Get URI to the endpoint

public getPath() : string
Return values
string —

URI to the endpoint

getQueryParameters()

Get query parameters

public getQueryParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

getTimeout()

Get request timeout

public getTimeout() : int
Return values
int —

Request timeout in milliseconds

setEnsureHttps()

Sets if HTTPS must be chosen over HTTP for this request

public setEnsureHttps(mixed $ensure_https) : mixed
Parameters
$ensure_https : mixed
Return values
mixed —

setTimeout()

Sets request timeout

public setTimeout(mixed $timeout) : mixed
Parameters
$timeout : mixed
Return values
mixed —

Search results