|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <title>JSDoc: Source: requests/delete-view-portion.js</title> |
| 6 | + |
| 7 | + <script src="scripts/prettify/prettify.js"> </script> |
| 8 | + <script src="scripts/prettify/lang-css.js"> </script> |
| 9 | + <!--[if lt IE 9]> |
| 10 | + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> |
| 11 | + <![endif]--> |
| 12 | + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> |
| 13 | + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> |
| 14 | +</head> |
| 15 | + |
| 16 | +<body> |
| 17 | + |
| 18 | +<div id="main"> |
| 19 | + |
| 20 | + <h1 class="page-title">Source: requests/delete-view-portion.js</h1> |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | + <section> |
| 28 | + <article> |
| 29 | + <pre class="prettyprint source linenums"><code>/* |
| 30 | + This file is auto-generated, do not edit |
| 31 | +*/ |
| 32 | + |
| 33 | +'use strict'; |
| 34 | +const rqs = require("./request"); |
| 35 | + |
| 36 | +/** |
| 37 | + * The view portions feature is currently experimental. |
| 38 | + * Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database. |
| 39 | + */ |
| 40 | +class DeleteViewPortion extends rqs.Request { |
| 41 | + |
| 42 | + /** |
| 43 | + * Construct the request |
| 44 | + * @param {string} userId - ID of the user who rated the item. |
| 45 | + * @param {string} itemId - ID of the item which was rated. |
| 46 | + * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value |
| 47 | + * - Allowed parameters: |
| 48 | + * - *sessionId* |
| 49 | + * - Type: string |
| 50 | + * - Description: Identifier of a session. |
| 51 | + */ |
| 52 | + constructor(userId, itemId, optional) { |
| 53 | + super('DELETE', '/viewportions/', 1000, false); |
| 54 | + this.userId = userId; |
| 55 | + this.itemId = itemId; |
| 56 | + optional = optional || {}; |
| 57 | + this.sessionId = optional.sessionId; |
| 58 | + } |
| 59 | + |
| 60 | + /** |
| 61 | + * Get body parameters |
| 62 | + * @return {Object} The values of body parameters (name of parameter: value of the parameter) |
| 63 | + */ |
| 64 | + bodyParameters() { |
| 65 | + let params = {}; |
| 66 | + |
| 67 | + return params; |
| 68 | + } |
| 69 | + |
| 70 | + /** |
| 71 | + * Get query parameters |
| 72 | + * @return {Object} The values of query parameters (name of parameter: value of the parameter) |
| 73 | + */ |
| 74 | + queryParameters() { |
| 75 | + let params = {}; |
| 76 | + params.userId = this.userId; |
| 77 | + params.itemId = this.itemId; |
| 78 | + if (this.sessionId !== undefined) |
| 79 | + params.sessionId = this.sessionId; |
| 80 | + return params; |
| 81 | + } |
| 82 | +} |
| 83 | + |
| 84 | +exports.DeleteViewPortion = DeleteViewPortion |
| 85 | +</code></pre> |
| 86 | + </article> |
| 87 | + </section> |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | +</div> |
| 93 | + |
| 94 | +<nav> |
| 95 | + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ItemBasedRecommendation.html">ItemBasedRecommendation</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UserBasedRecommendation.html">UserBasedRecommendation</a></li></ul> |
| 96 | +</nav> |
| 97 | + |
| 98 | +<br class="clear"> |
| 99 | + |
| 100 | +<footer> |
| 101 | + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.3</a> on Mon Sep 18 2017 14:49:12 GMT+0200 (CEST) |
| 102 | +</footer> |
| 103 | + |
| 104 | +<script> prettyPrint(); </script> |
| 105 | +<script src="scripts/linenumber.js"> </script> |
| 106 | +</body> |
| 107 | +</html> |
0 commit comments