Package recombee_api_client :: Package api_requests :: Module add_bookmark :: Class AddBookmark
[hide private]
[frames] | no frames]

Class AddBookmark

source code

     object --+    
              |    
request.Request --+
                  |
                 AddBookmark

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

Instance Methods [hide private]
 
__init__(self, user_id, item_id, timestamp=UUID('b01151c6-958b-488b-b2d4-8f4f3176d25f'), cascade_create=UUID('b01151c6-958b-488b-b2d4-8f4f3176d25f'), recomm_id=UUID('b01151c6-958b-488b-b2d4-8f4f3176d25f'))
Required parameters:
source code
 
get_body_parameters(self)
Values of body parameters as a dictionary (name of parameter: value of the parameter).
source code
 
get_query_parameters(self)
Values of query parameters as a dictionary (name of parameter: value of the parameter).
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from request.Request: quote_path_param

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, user_id, item_id, timestamp=UUID('b01151c6-958b-488b-b2d4-8f4f3176d25f'), cascade_create=UUID('b01151c6-958b-488b-b2d4-8f4f3176d25f'), recomm_id=UUID('b01151c6-958b-488b-b2d4-8f4f3176d25f'))
(Constructor)

source code 

Required parameters:

Parameters:
  • user_id - User who bookmarked the item
  • item_id - Bookmarked item

    Optional parameters:

  • timestamp - UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
  • cascade_create - Sets whether the given user/item should be created if not present in the database.
  • recomm_id - If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
Overrides: object.__init__