zaccl
Version:
The Zoom App Complete Connection Library, a project that handles everything required to build a zoom-integrated app.
332 lines (305 loc) • 15.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>ECatWebinar.js - 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#listAccountRecordings">listAccountRecordings</a></li><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><li data-type='method'><a href="api.cloudRecording.html#recoverMeetingRecordings">recoverMeetingRecordings</a></li></ul></li><li><a href="api.group.html">api.group</a><ul class='methods'><li data-type='method'><a href="api.group.html#listGroupMembers">listGroupMembers</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#getActivitiesReport">getActivitiesReport</a></li><li data-type='method'><a href="api.meeting.html#getParticipantReport">getParticipantReport</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#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.meeting.html#getTranscript">getTranscript</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastMeetingParticipants">listPastMeetingParticipants</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#getParticipantReport">getParticipantReport</a></li><li data-type='method'><a href="api.webinar.html#getPollReport">getPollReport</a></li><li data-type='method'><a href="api.webinar.html#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
</nav>
<div id="main">
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
/**
* Category of endpoints for Zoom webinars
* @author Gabe Abrams
* @namespace api.webinar
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
// Import shared interfaces
const EndpointCategory_1 = __importDefault(require("../shared/interfaces/EndpointCategory"));
class ECatWebinar extends EndpointCategory_1.default {
/**
* Get info on a Webinar (Light)
* @author Gabe Abrams
* @instance
* @memberof api.webinar
* @method get
* @param {object} opts object containing all arguments
* @param {number} opts.webinarId the Zoom ID of the Webinar
* @param {string} [opts.occurrenceId] ID for the Webinar occurrence
* @param {boolean} [opts.showAllOccurrences=false] if truthy,
* retrieves all past occurrences
* @returns {Webinar} Zoom Webinar object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinar}
*/
get(opts) {
return __awaiter(this, void 0, void 0, function* () {
// Initialize params object
const params = {
show_previous_occurrences: !!opts.showAllOccurrences,
};
// Add optional param if exists
if (opts.occurrenceId) {
params.occurrence_id = opts.occurrenceId;
}
return this.visitEndpoint({
path: `/webinars/${opts.webinarId}`,
action: 'get info on a webinar',
method: 'GET',
params,
errorMap: {
300: 'Invalid Webinar ID',
400: {
1010: 'The Zoom user could not be found on this account',
},
404: {
1001: 'We could not find the webinar because the Zoom user does not exist',
3001: `Webinar ${opts.webinarId} could not be found or has expired`,
},
},
});
});
}
/**
* Create a webinar (Light)
* @author Gabe Abrams
* @instance
* @memberof api.webinar
* @method create
* @param opts object containing all arguments
* @param opts.userId the user ID or email address of the user
* who will own the webinar
* @param opts.webinarObj Zoom webinar object with webinar
* details {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#request-body}
* @returns Zoom Webinar object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#responses}
*/
create(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/users/${opts.userId}/webinars`,
action: 'create a webinar',
method: 'POST',
params: opts.webinarObj,
errorMap: {
300: 'Invalid Webinar ID',
400: {
1010: 'The Zoom user could not be found on this account',
},
404: {
1001: 'We could not find the webinar because the Zoom user does not exist',
3001: 'Webinar could not be located',
},
},
});
});
}
/**
* Add one panelist if not already in the list (Medium)
* @author Gabe Abrams
* @instance
* @memberof api.webinar
* @method addPanelist
* @param opts object containing all arguments
* @param opts.webinarId the id for the webinar to add a
* panelist to
* @param opts.panelistName the name of the panelist
* @param opts.panelistId the email or id of the panelist
*/
addPanelist(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/webinars/${opts.webinarId}/panelists`,
action: 'add a panelist to a webinar',
method: 'POST',
params: {
panelists: [
{
name: opts.panelistName,
email: opts.panelistId,
},
],
},
errorMap: {
400: {
1010: 'The Zoom user could not be found on this account',
},
404: {
1001: 'We could not find the webinar because the Zoom user does not exist',
3001: `Webinar ${opts.webinarId} could not be found or has expired`,
},
},
});
});
}
/**
* Get a list of panelists for a webinar (Medium)
* @author Gabe Abrams
* @instance
* @memberof api.webinar
* @method listPanelists
* @param opts object containing all arguments
* @param opts.webinarId the id for the webinar to query
* @returns list of panelists
*/
listPanelists(opts) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.visitEndpoint({
path: `/webinars/${opts.webinarId}/panelists`,
action: 'get the list of panelist for a webinar',
method: 'GET',
errorMap: {
400: {
1010: 'The Zoom user could not be found on this account',
},
404: {
1001: 'We could not find the webinar because the Zoom user does not exist',
3001: `Webinar ${opts.webinarId} could not be found or has expired`,
},
},
itemKey: 'panelists',
});
// Just keep list of panelists
return response.panelists;
});
}
/**
* Get a list of participants for a webinar (Heavy)
* @author Gabe Abrams
* @instance
* @memberof api.webinar
* @method getParticipantReport
* @param opts object containing all arguments
* @param opts.webinarId the id for the webinar to query
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
* for custom throttle control
* @returns list of participants
*/
getParticipantReport(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/report/webinars/${opts.webinarId}/participants`,
action: 'get participant report for a webinar',
method: 'GET',
params: {
page_size: 300, // Max page size
},
onNewPage: opts.onNewPage,
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
errorMap: {
400: {
1010: 'The Zoom user could not be found on this account',
12702: 'Cannot access a webinar from more than a year ago',
200: 'No permission to access this webinar',
},
404: {
3001: `Webinar ${opts.webinarId} could not be found or has expired`,
},
},
});
});
}
/**
* Get a poll report for a webinar (Heavy)
* @author Gabe Abrams
* @instance
* @memberof api.webinar
* @method getPollReport
* @param opts object containing all arguments
* @param opts.webinarId the id for the webinar to query
* @returns list of polls
*/
getPollReport(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/report/webinars/${opts.webinarId}/polls`,
action: 'get poll report for a webinar',
method: 'GET',
errorMap: {
400: {
1010: 'The Zoom user could not be found on this account',
12702: 'Cannot access a webinar from more than a year ago',
200: 'No permission to access this webinar',
},
404: {
3001: `Webinar ${opts.webinarId} could not be found or has expired`,
},
},
});
});
}
/**
* Get a Q&A report for a webinar (Heavy)
* @author Gabe Abrams
* @instance
* @memberof api.webinar
* @method getQAReport
* @param opts object containing all arguments
* @param opts.webinarId the id for the webinar to query
* @returns Q&A report for the webinar
*/
getQAReport(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/report/webinars/${opts.webinarId}/qa`,
action: 'get Q&A report for a webinar',
method: 'GET',
errorMap: {
400: {
1010: 'The Zoom user could not be found on this account',
12702: 'Cannot access a webinar from more than a year ago',
200: 'No permission to access this webinar',
},
404: {
3001: `Webinar ${opts.webinarId} could not be found or has expired`,
},
},
});
});
}
}
/*------------------------------------------------------------------------*/
/* Export */
/*------------------------------------------------------------------------*/
exports.default = ECatWebinar;
//# sourceMappingURL=ECatWebinar.js.map</code></pre>
</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>