zaccl
Version:
The Zoom App Complete Connection Library, a project that handles everything required to build a zoom-integrated app.
713 lines (234 loc) • 12.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>cloudRecording - Documentation</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.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
<h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
</nav>
<div id="main">
<section>
<header>
<h2>
cloudRecording
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line2">line 2</a>
</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Gabe Abrams</li>
<li>Aryan Pandey</li>
</ul>
</dd>
</dl>
<div class="description usertext">Category of endpoints for Zoom cloud recordings</div>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="listMeetingRecordings"><span class="type-signature"></span>listMeetingRecordings<span class="signature">(opts)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line75">line 75</a>
</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Aryan Pandey</li>
</ul>
</dd>
</dl>
<div class="description usertext">
Get all recordings of a meeting
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
</td>
<td class="description last">object containing all arguments</td>
</tr>
<tr>
<td class="name"><code>options.meetingId</code></td>
<td class="type">
</td>
<td class="description last">the Zoom meeting ID or UUID</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
list of Zoom meeting recording objects <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingget#responses">https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingget#responses</a>
</div>
<h4 class="name" id="listUserRecordings"><span class="type-signature"></span>listUserRecordings<span class="signature">(opts)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line113">line 113</a>
</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Aryan Pandey</li>
</ul>
</dd>
</dl>
<div class="description usertext">
List all cloud recordings of a user
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
</td>
<td class="description last">object containing all arguments
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>userId</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">the user ID or email address of the user</td>
</tr>
<tr>
<td class="name"><code>pageSize</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>300</code>
</td>
<td class="description last">number of records
returned from a single API call</td>
</tr>
<tr>
<td class="name"><code>nextPageToken</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">token used to pageinate
through large result sets</td>
</tr>
<tr>
<td class="name"><code>searchTrash</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last">set to true to retrieve
meeting recordings from the trash.</td>
</tr>
<tr>
<td class="name"><code>startDate</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>1 month before today</code>
</td>
<td class="description last">string accepted by JS Date constructor or instance of Date object.
Date needs to be within past 6 months. Time data (hours and seconds)
is discarded</td>
</tr>
<tr>
<td class="name"><code>endDate</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">string accepted by JS Date
constructor or instance of Date object.
Date needs to be within past 6 months. Time data (hours and seconds)
is discarded</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
List of Zoom Recordings <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingslist#responses">https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingslist#responses</a>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
We use <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> and the <a href="https://github.com/clenemt/docdash">docdash</a> theme to generate our docs.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>