com.recombee.api_client.api_requests

Class DeleteBookmark

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.DeleteBookmark

public class DeleteBookmark
extends Request

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	itemId ID of the item of which was bookmarked.
protected java.util.Date	timestamp Unix timestamp of the bookmark.
protected java.lang.String	userId ID of the user who made the bookmark.

Fields inherited from class com.recombee.api_client.api_requests.Request

timeout

Constructor Summary

Constructors

Constructor and Description
DeleteBookmark(java.lang.String userId, java.lang.String itemId) Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getBodyParameters() Get body parameters
HTTPMethod	getHTTPMethod()
java.lang.String	getItemId()
java.lang.String	getPath()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.util.Date	getTimestamp()
java.lang.String	getUserId()
DeleteBookmark	setTimestamp(java.util.Date timestamp)

Methods inherited from class com.recombee.api_client.api_requests.Request

getEnsureHttps, getTimeout, setTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userId

protected java.lang.String userId

ID of the user who made the bookmark.

itemId

protected java.lang.String itemId

ID of the item of which was bookmarked.

timestamp

protected java.util.Date timestamp

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

Constructor Detail

DeleteBookmark

public DeleteBookmark(java.lang.String userId,
                      java.lang.String itemId)

Construct the request

Parameters:

userId - ID of the user who made the bookmark.

itemId - ID of the item of which was bookmarked.

Method Detail

setTimestamp

public DeleteBookmark setTimestamp(java.util.Date timestamp)

Parameters:

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

getUserId

public java.lang.String getUserId()

getItemId

public java.lang.String getItemId()

getTimestamp

public java.util.Date getTimestamp()

getHTTPMethod

public HTTPMethod getHTTPMethod()

Specified by:

getHTTPMethod in class Request

Returns:

Used HTTP method

getPath

public java.lang.String getPath()

Specified by:

getPath in class Request

Returns:

URI to the endpoint including path parameters

getQueryParameters

public java.util.Map<java.lang.String,java.lang.Object> getQueryParameters()

Get query parameters

Specified by:

getQueryParameters in class Request

Returns:

Values of query parameters (name of parameter: value of the parameter)

getBodyParameters

public java.util.Map<java.lang.String,java.lang.Object> getBodyParameters()

Get body parameters

Specified by:

getBodyParameters in class Request

Returns:

Values of body parameters (name of parameter: value of the parameter)