out/backend_client-pkg_services_CanvasCreationService.js.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: backend/client-pkg/services/CanvasCreationService.js</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Source: backend/client-pkg/services/CanvasCreationService.js</h1>

    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>/**
* @file Defines a function that creates and sends a request to the CanvasCreationService
*/

const CNVS_CRTN_SVC_ROUTE = require('../common/Constants').CNVS_CRTN_SVC_ROUTE;
const PostRequestHelper = require('../common/PostRequestHelper');

/**
* Forms the body of a POST request  to the CanvasCreationService
* @param {string} creatingUser The uid of the user making the request
* @throws Exceptions on invalid parameter types
* @returns {object} A POST request body that can be sent to the CanvasCreationService
*/
const formPostBody = (creatingUser) => {
  if(typeof creatingUser !== 'string')
    throw 'Error forming request to create canvas. Invalid creatingUser param, must be a String.'

  return {
    creatingUser,
  }
};

/**
* Constructs and sends a request to the CanvasCreationService
* @param {object} reqBody An object containing the POST request body
* @param {object} endpoint An object containing the endpoint to send the req to
* @param {function} resCallback A callback that will be passed the JSON object of the request response
* @returns {void}
*/
const postRequest = (reqBody, endpoint, resCallback, errCallback) => {
  PostRequestHelper.postRequest(reqBody, endpoint,
    CNVS_CRTN_SVC_ROUTE, resCallback, errCallback);
};

module.exports = {
  formPostBody,
  postRequest,
};
</code></pre>
        </article>
    </section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Canvas.html">Canvas</a></li><li><a href="CanvasElement.html">CanvasElement</a></li><li><a href="CanvasList.html">CanvasList</a></li><li><a href="CanvasOrientationBtns.html">CanvasOrientationBtns</a></li><li><a href="CanvasView.html">CanvasView</a></li><li><a href="ClearPreviewBtn.html">ClearPreviewBtn</a></li><li><a href="CreateCanvas.html">CreateCanvas</a></li><li><a href="DashNavBar.html">DashNavBar</a></li><li><a href="ExportModal.html">ExportModal</a></li><li><a href="ImportModelModal.html">ImportModelModal</a></li><li><a href="Landing.html">Landing</a></li><li><a href="MainLayout.html">MainLayout</a></li><li><a href="OptionsBar.html">OptionsBar</a></li><li><a href="Preview3D.html">Preview3D</a></li><li><a href="Render3DBtn.html">Render3DBtn</a></li><li><a href="ResizeTextfields.html">ResizeTextfields</a></li><li><a href="RotationSlider.html">RotationSlider</a></li><li><a href="SaveImgBtn.html">SaveImgBtn</a></li><li><a href="ShareCanvasModal.html">ShareCanvasModal</a></li><li><a href="Sidebar.html">Sidebar</a></li></ul><h3>Global</h3><ul><li><a href="global.html#activeElementReducer">activeElementReducer</a></li><li><a href="global.html#addCanvas">addCanvas</a></li><li><a href="global.html#addCanvasUser">addCanvasUser</a></li><li><a href="global.html#addElement">addElement</a></li><li><a href="global.html#addUserToCanvasByEmail">addUserToCanvasByEmail</a></li><li><a href="global.html#addUserToCanvasByUid">addUserToCanvasByUid</a></li><li><a href="global.html#CanvasError">CanvasError</a></li><li><a href="global.html#canvasReducer">canvasReducer</a></li><li><a href="global.html#clear">clear</a></li><li><a href="global.html#cloneElement">cloneElement</a></li><li><a href="global.html#craftmlCodeReducer">craftmlCodeReducer</a></li><li><a href="global.html#Dashboard">Dashboard</a></li><li><a href="global.html#deleteElement">deleteElement</a></li><li><a href="global.html#formPostBody">formPostBody</a></li><li><a href="global.html#generateScript">generateScript</a></li><li><a href="global.html#getAuthState">getAuthState</a></li><li><a href="global.html#getFirebaseUserByEmail">getFirebaseUserByEmail</a></li><li><a href="global.html#getRenderedImageUrl">getRenderedImageUrl</a></li><li><a href="global.html#getRequest">getRequest</a></li><li><a href="global.html#getUserInfo">getUserInfo</a></li><li><a href="global.html#handleCorsRequest">handleCorsRequest</a></li><li><a href="global.html#initElements">initElements</a></li><li><a href="global.html#initFirebase">initFirebase</a></li><li><a href="global.html#insertIntoState">insertIntoState</a></li><li><a href="global.html#LandingContent">LandingContent</a></li><li><a href="global.html#LandingNavBar">LandingNavBar</a></li><li><a href="global.html#LoadingIndicator">LoadingIndicator</a></li><li><a href="global.html#mainReducers">mainReducers</a></li><li><a href="global.html#PageNotFound">PageNotFound</a></li><li><a href="global.html#performAndDispatchLogin">performAndDispatchLogin</a></li><li><a href="global.html#postRequest">postRequest</a></li><li><a href="global.html#removeCanvas">removeCanvas</a></li><li><a href="global.html#removeCanvasUser">removeCanvasUser</a></li><li><a href="global.html#removeElement">removeElement</a></li><li><a href="global.html#removeElementAndPersist">removeElementAndPersist</a></li><li><a href="global.html#removeField">removeField</a></li><li><a href="global.html#Routes">Routes</a></li><li><a href="global.html#saveRenderedImage">saveRenderedImage</a></li><li><a href="global.html#setAuthState">setAuthState</a></li><li><a href="global.html#setAutoCodeUpdate">setAutoCodeUpdate</a></li><li><a href="global.html#setCanvasName">setCanvasName</a></li><li><a href="global.html#setCanvasNameAndPersist">setCanvasNameAndPersist</a></li><li><a href="global.html#setCanvasOrientation">setCanvasOrientation</a></li><li><a href="global.html#setCanvasOrientationAndPersist">setCanvasOrientationAndPersist</a></li><li><a href="global.html#setCanvasOwner">setCanvasOwner</a></li><li><a href="global.html#setCode">setCode</a></li><li><a href="global.html#setElementLocation">setElementLocation</a></li><li><a href="global.html#setElementRotation">setElementRotation</a></li><li><a href="global.html#setElementSize">setElementSize</a></li><li><a href="global.html#setHasCanvasImage">setHasCanvasImage</a></li><li><a href="global.html#SideBar">SideBar</a></li><li><a href="global.html#signOut">signOut</a></li><li><a href="global.html#storeConstructor">storeConstructor</a></li><li><a href="global.html#targetElement">targetElement</a></li><li><a href="global.html#updateAndPersist">updateAndPersist</a></li><li><a href="global.html#updateElement">updateElement</a></li><li><a href="global.html#updateElementReducer">updateElementReducer</a></li><li><a href="global.html#updateUserInfo">updateUserInfo</a></li><li><a href="global.html#userInfoReducer">userInfoReducer</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.0-dev</a> on Fri May 05 2017 07:15:02 GMT-0600 (Mountain Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>