DeleteViewPortion

Extends \Recombee\RecommApi\Requests\Request

Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database.

package

Default

Methods

Construct the request

__construct(string $user_id, string $item_id, array $optional = array()) 
Throws
\Recombee\RecommApi\Requests\Exceptions\UnknownOptionalParameterException

UnknownOptionalParameterException if an unknown optional parameter is given in $optional

Arguments

$user_id

string

ID of the user who rated the item.

$item_id

string

ID of the item which was rated.

$optional

array

Optional parameters given as an array containing pairs name of the parameter => value

  • Allowed parameters:
    • sessionId
      • Type: string
      • Description: Identifier of a session.

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

ID of the user who rated the item.

user_id : string
var

ID of the user who rated the item.

Type(s)

string

ID of the item which was rated.

item_id : string
var

ID of the item which was rated.

Type(s)

string

Identifier of a session.

session_id : string
var

Identifier of a session.

Type(s)

string

Array containing values of optional parameters

optional : array
var

Array containing values of optional parameters

Type(s)

array

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