gsweet
Version:
Help with writing scripts to run against gSuite
446 lines (122 loc) • 5.69 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: sheets/sheetService.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">Module: sheets/sheetService.js</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Creat the Google drive service needed to hit the Drive API</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Tod Gentille</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sheets_sheetService.js.html">sheets/sheetService.js</a>, <a href="sheets_sheetService.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Requires</h3>
<ul>
<li>module:NPM:googleapis</li>
<li>module:../googleAuthHelper</li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="~_sheetService"><span class="type-signature">(inner) </span>_sheetService<span class="type-signature"> :Object</span></h4>
<div class="description">
<p>holds the sheetService created by init()</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sheets_sheetService.js.html">sheets/sheetService.js</a>, <a href="sheets_sheetService.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~getSheetServiceDefault"><span class="type-signature">(inner) </span>getSheetServiceDefault<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>Get the default Google Sheet API service.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sheets_sheetService.js.html">sheets/sheetService.js</a>, <a href="sheets_sheetService.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the actual Google Sheet Service</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="~init"><span class="type-signature">(inner) </span>init<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
<p>This needs to be called just once.
The results of this function are stored in <code>_sheetService</code>.
If no service is passed to init it grabs the default Google Sheet Service.
Passing the service in makes it easy to do unit testing since a Fake can
be passed in.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="sheets_sheetService.js.html">sheets/sheetService.js</a>, <a href="sheets_sheetService.js.html#line25">line 25</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the service. Typically not needed by caller.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="Drive_driveOps.module_test.html">test</a></li><li><a href="module-drive_driveOps.html">drive/driveOps</a></li><li><a href="module-Drive_driveOps%2520Integration%2520Tests.html">Drive/driveOps Integration Tests</a></li><li><a href="module-drive_driveService.html">drive/driveService</a></li><li><a href="module-Sheet_sheetOps%2520Integration%2520Tests.html">Sheet/sheetOps Integration Tests</a></li><li><a href="sheets_sheetOps.module_js.html">sheets/sheetOps.js</a></li><li><a href="sheets_sheetService.module_js.html">sheets/sheetService.js</a></li><li><a href="-_sheetOps.module_test.html">test</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat May 11 2019 23:52:27 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>