Recombee API client
Back to top  

AddBookmark

Extends \Recombee\RecommApi\Requests\Request

Adds a bookmark of a given item made by a given user.

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

User who bookmarked the item

$item_id

string

Bookmarked item

$optional

array

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

  • Allowed parameters:
    • timestamp
      • Type: string|float
      • Description: UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    • cascadeCreate
      • Type: bool
      • Description: Sets whether the given user/item should be created if not present in the database.
    • recommId
      • Type: string
      • Description: If this bookmark is based on a recommendation request, recommId is the id of the clicked recommendation.

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

User who bookmarked the item

user_id : string
var

User who bookmarked the item

Type(s)

string

Bookmarked item

item_id : string
var

Bookmarked item

Type(s)

string

UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

timestamp : string|float
var

UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

Type(s)

string|float

Sets whether the given user/item should be created if not present in the database.

cascade_create : boolean
var

Sets whether the given user/item should be created if not present in the database.

Type(s)

boolean

If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.

recomm_id : string
var

If this bookmark is based on a recommendation request, recommId is the id of the clicked recommendation.

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