DeleteBookmark

Extends \Recombee\RecommApi\Requests\Request

Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp` or all the bookmarks with given `userId` and `itemId` if `timestamp` is omitted.

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 made the bookmark.

$item_id

string

ID of the item of which was bookmarked.

$optional

array

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

  • Allowed parameters:
    • timestamp
      • Type: float
      • Description: Unix timestamp of the bookmark. If the timestamp is omitted, then all the bookmarks with given userId and itemId are deleted.

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 made the bookmark.

user_id : string
var

ID of the user who made the bookmark.

Type(s)

string

ID of the item of which was bookmarked.

item_id : string
var

ID of the item of which was bookmarked.

Type(s)

string

Unix timestamp of the bookmark. If the `timestamp` is omitted, then all the bookmarks with given `userId` and `itemId` are deleted.

timestamp : float
var

Unix timestamp of the bookmark. If the timestamp is omitted, then all the bookmarks with given userId and itemId are deleted.

Type(s)

float

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