zaccl
Version:
The Zoom App Complete Connection Library, a project that handles everything required to build a zoom-integrated app.
2,154 lines (661 loc) • 29.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>meeting - 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>
meeting
</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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.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 meetings</div>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addAltHost"><span class="type-signature"></span>addAltHost<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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line509">line 509</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">
Add one alt-host if not already in the list. If another user in the alt-host
list has been deactivated, all alt-hosts are removed and the requested
user is added as the only alt-host. This is because Zoom doesn't give us
enough information to determine which user is deactivated, and thus,
the only way to resolve the issue is to remove all previously existing
alt-hosts.
</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 class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>meetingId</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last">the id for the meeting to add hosts to</td>
</tr>
<tr>
<td class="name"><code>altHost</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last">the email or id of the alt host to
be added</td>
</tr>
<tr>
<td class="name"><code>meetingObj</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Zoom meeting object that needs to be
updated. Meeting ID is not used to fetch meeting if this object is passed</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
updated meeting object after adding alternative host
</div>
<h4 class="name" id="create"><span class="type-signature"></span>create<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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line132">line 132</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">
Create a new 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
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>userId</code></td>
<td class="type">
</td>
<td class="description last">the user ID or email address of the user</td>
</tr>
<tr>
<td class="name"><code>meetingObj</code></td>
<td class="type">
</td>
<td class="description last">Zoom meeting object with meeting details <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body">https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body</a>}</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Zoom meeting object <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body">https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body</a>}
</div>
<h4 class="name" id="delete"><span class="type-signature"></span>delete<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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line201">line 201</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">
Delete 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
<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>meetingId</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">the Zoom ID of the meeting</td>
</tr>
<tr>
<td class="name"><code>occurrenceId</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">ID for the meeting occurrence</td>
</tr>
<tr>
<td class="name"><code>notifyHosts</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last">if truthy,
sends cancellation email to hosts</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Zoom meeting object <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body">https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body</a>}
</div>
<h4 class="name" id="get"><span class="type-signature"></span>get<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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line87">line 87</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">
Get info on 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
<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>meetingId</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">the Zoom ID of the meeting</td>
</tr>
<tr>
<td class="name"><code>occurrenceId</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">ID for the meeting occurrence</td>
</tr>
<tr>
<td class="name"><code>showAllOccurrences</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last">if truthy,
retrieves all past occurrences</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Zoom meeting object <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting#responses">https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting#responses</a>
</div>
<h4 class="name" id="getPastMeetingDetails"><span class="type-signature"></span>getPastMeetingDetails<span class="signature">(uuid)</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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line276">line 276</a>
</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Yuen Ler Chow</li>
</ul>
</dd>
</dl>
<div class="description usertext">
Get details of a past meeting instance
</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>uuid</code></td>
<td class="type">
</td>
<td class="description last">the Zoom UUID of the meeting</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
details of a past meeting instance
</div>
<h4 class="name" id="getPollInfo"><span class="type-signature"></span>getPollInfo<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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line407">line 407</a>
</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Yuen Ler Chow</li>
</ul>
</dd>
</dl>
<div class="description usertext">
Get poll info
</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 class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>meetingId</code></td>
<td class="type">
</td>
<td class="description last">the Zoom ID of the meeting</td>
</tr>
<tr>
<td class="name"><code>pollId</code></td>
<td class="type">
</td>
<td class="description last">the id of the poll</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
object with all info about the poll
</div>
<h4 class="name" id="listPastInstances"><span class="type-signature"></span>listPastInstances<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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line251">line 251</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">
Get a list of ended meeting instances
</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 class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>meetingId</code></td>
<td class="type">
</td>
<td class="description last">the Zoom ID of the meeting</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
list of ended meeting instances <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/pastmeetings#responses">https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/pastmeetings#responses</a>
</div>
<h4 class="name" id="listPastPollOccurrences"><span class="type-signature"></span>listPastPollOccurrences<span class="signature">()</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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line307">line 307</a>
</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Yuen Ler Chow</li>
</ul>
</dd>
</dl>
<div class="description usertext">
List past poll occurrences
</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.uuid</code></td>
<td class="type">
</td>
<td class="description last">the Zoom UUID of the meeting</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
list of past poll occurrences
</div>
<h4 class="name" id="update"><span class="type-signature"></span>update<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="ECatMeeting.js.html">ECatMeeting.js</a>, <a href="ECatMeeting.js.html#line162">line 162</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">
Update 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
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>meetingId</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last">the Zoom ID of the meeting</td>
</tr>
<tr>
<td class="name"><code>meetingObj</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last">Zoom meeting object with updated details <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingupdate#request-body">https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingupdate#request-body</a></td>
</tr>
<tr>
<td class="name"><code>occurrenceId</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">ID for the meeting occurrence</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Zoom meeting object <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body">https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body</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>