zaccl
Version:
The Zoom App Complete Connection Library, a project that handles everything required to build a zoom-integrated app.
756 lines (729 loc) • 37.9 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>ECatMeeting.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 meetings
* @author Gabe Abrams
* @author Aryan Pandey
* @namespace api.meeting
*/
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"));
// Import shared classes
const ZACCLError_1 = __importDefault(require("../shared/classes/ZACCLError"));
const ErrorCode_1 = __importDefault(require("../shared/types/ErrorCode"));
const ZoomPollQuestionAndAnswerType_1 = __importDefault(require("../types/ZoomPollQuestionAndAnswerType"));
const ZoomPollType_1 = __importDefault(require("../types/ZoomPollType"));
const ZoomPollStatus_1 = __importDefault(require("../types/ZoomPollStatus"));
class ECatMeeting extends EndpointCategory_1.default {
/**
* Get info on a meeting (Light)
* @author Gabe Abrams
* @author Aryan Pandey
* @instance
* @memberof api.meeting
* @method get
* @param opts object containing all arguments
* @param opts.meetingId the Zoom ID of the meeting
* @param [opts.occurrenceId] ID for the meeting occurrence
* @param [opts.showAllOccurrences=false] if truthy,
* retrieves all past occurrences
* @returns Zoom meeting object
*/
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;
}
// Send request
return this.visitEndpoint({
path: `/meetings/${opts.meetingId}`,
action: 'get info on a meeting',
method: 'GET',
params,
errorMap: {
400: {
1010: 'The Zoom user could not be found on this account',
3000: 'We could not access webinar info',
},
404: {
1001: 'We could not find the meeting because the Zoom user does not exist',
3001: `Meeting ${opts.meetingId} could not be found or has expired`,
},
},
});
});
}
/**
* Create a new meeting (Light)
* @author Gabe Abrams
* @author Aryan Pandey
* @instance
* @memberof api.meeting
* @method create
* @param opts object containing all arguments
* @param opts.userId the user ID or email address of the user
* @param opts.meetingObj Zoom meeting object with meeting details {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}}
* @returns Zoom meeting object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}}
*/
create(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/users/${opts.userId}/meetings`,
action: 'create a new meeting',
method: 'POST',
params: opts.meetingObj,
errorMap: {
300: `User ${opts.userId} has reached the maximum limit for creating and updating meetings`,
404: {
1001: `User ${opts.userId} either does not exist or does not belong to this account`,
},
},
});
});
}
/**
* Update a meeting (Light)
* @author Gabe Abrams
* @author Aryan Pandey
* @instance
* @memberof api.meeting
* @method update
* @param opts object containing all arguments
* @param opts.meetingId the Zoom ID of the meeting
* @param opts.meetingObj Zoom meeting object with updated details {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingupdate#request-body}
* @param [opts.occurrenceId] ID for the meeting occurrence
* @returns Zoom meeting object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}}
*/
update(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: (opts.occurrenceId
? `/meetings/${opts.meetingId}?occurrence_id=${opts.occurrenceId}`
: `/meetings/${opts.meetingId}`),
action: 'update the details of a meeting',
method: 'PATCH',
params: opts.meetingObj,
errorMap: {
300: 'We cannot create or update any more meetings today. Please try again tomorrow',
400: {
1010: 'We could not find the Zoom user on this account',
3000: 'We could not access meeting information',
3003: `You cannot update the meeting ${opts.meetingId} since you are not the meeting host`,
},
404: {
1001: 'We could not update the meeting because the user does not exist',
3001: `A meeting with the ID ${opts.meetingId} could not be found or has expired`,
},
},
});
});
}
/**
* Delete a meeting (Light)
* @author Gabe Abrams
* @author Aryan Pandey
* @instance
* @memberof api.meeting
* @method delete
* @param opts object containing all arguments
* @param opts.meetingId the Zoom ID of the meeting
* @param [opts.occurrenceId] ID for the meeting occurrence
* @param [opts.notifyHosts=false] if truthy,
* sends cancellation email to hosts
* @returns Zoom meeting object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}}
*/
delete(opts) {
return __awaiter(this, void 0, void 0, function* () {
// Initialize params object
const params = {
schedule_for_reminder: !!opts.notifyHosts,
};
// Add optional param if exists
if (opts.occurrenceId) {
params.occurrence_id = opts.occurrenceId;
}
// Send request
return this.visitEndpoint({
path: `/meetings/${opts.meetingId}`,
action: 'delete a meeting',
method: 'DELETE',
params,
errorMap: {
400: {
1010: `We could not delete meeting ${opts.meetingId} because the user does not belong to this account`,
3000: `We could not access meeting information for meeting ${opts.meetingId}`,
3002: `We could not delete the meeting ${opts.meetingId} since it is still in progress`,
3003: `You cannot delete the meeting ${opts.meetingId} since you are not the meeting host`,
3007: `You cannot delete the meeting ${opts.meetingId} since it has already ended`,
3018: 'You are not allowed to delete your Personal Meeting ID',
3037: 'You are not allowed to delete a Personal Meeting Conference',
},
404: {
1001: `We could not delete the meeting ${opts.meetingId} because the user does not exist`,
3001: `A meeting with the ID ${opts.meetingId} could not be found or has expired`,
},
},
});
});
}
/**
* Get a list of ended meeting instances (Medium)
* @author Gabe Abrams
* @author Aryan Pandey
* @instance
* @memberof api.meeting
* @method listPastInstances
* @param opts object containing all arguments
* @param opts.meetingId the Zoom ID of the meeting
* @returns list of ended meeting instances {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/pastmeetings#responses}
*/
listPastInstances(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/past_meetings/${opts.meetingId}/instances`,
action: 'get the list of ended meeting instances',
method: 'GET',
errorMap: {
404: `We could not find a meeting with the ID ${opts.meetingId}`,
},
itemKey: 'meetings',
});
});
}
/**
* Get details of a past meeting instance (Light)
* @author Yuen Ler Chow
* @instance
* @memberof api.meeting
* @method getPastMeetingDetails
* @param uuid the Zoom UUID of the meeting
* @returns details of a past meeting instance
*/
getPastMeetingDetails(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/past_meetings/${opts.uuid}`,
action: 'get the details of a past meeting instance',
method: 'GET',
errorMap: {
400: {
1010: 'User does not exist or does not belong to this account',
300: 'We could not access the details of this past meeting.',
200: 'You need a paid account to access details of a past meeting.',
12702: 'You are not allowed to access information about meetings that occurred more than 1 year ago.',
},
404: {
3001: 'The meeting ID is invalid or the meeting has not ended.',
}
},
});
});
}
/**
* List past poll occurrences (Medium)
* @author Yuen Ler Chow
* @instance
* @memberof api.meeting
* @method listPastPollOccurrences
* @param opts.uuid the Zoom UUID of the meeting
* @returns list of past poll occurrences
*/
listPastPollOccurrences(opts) {
return __awaiter(this, void 0, void 0, function* () {
// Ask Zoom for unprocessed poll data
const response = yield this.visitEndpoint({
path: `/past_meetings/${opts.uuid}/polls`,
action: 'get the list of polls that occurred in a past meeting',
method: 'GET',
errorMap: {
400: 'We could not access the poll data for this meeting.',
12702: 'You are not allowed to access information about meetings that occurred more than 1 year ago.',
},
});
// Process and return poll occurrences
const pollIdToOccurrenceMap = {};
// Process each poll response
response.questions.forEach((user) => {
const { email, name, question_details: questionDetails, } = user;
// Loop through each answer
questionDetails.forEach((questionDetail) => {
const { date_time: dateTime, polling_id: pollId, question, } = questionDetail;
// Parse answer
const answer = ((!questionDetail.answer
|| String(questionDetail.answer.trim()).length === 0)
? [] // no answer, return empty array
: (String(questionDetail.answer)
.split(';')
.map((a) => {
return a.trim();
})));
// Parse date time as ms since epoch
// dateTime is a YYYY-MM-DD HH:MM:SS string in UTC time, but not
// formatted correctly. Fix formatting before parsing:
const pollTime = new Date(`${dateTime} UTC`).getTime();
// Reformat as a response object
const response = {
userFullName: name,
userEmail: email,
answer,
timestamp: pollTime,
};
// If poll occurrence isn't in the map, add it.
if (!pollIdToOccurrenceMap[pollId]) {
pollIdToOccurrenceMap[pollId] = {
pollId: pollId,
timestamp: pollTime,
questions: [
{
prompt: question,
responses: [response],
},
]
};
}
else {
// Poll occurrence is in the map
const questionIndex = (pollIdToOccurrenceMap[pollId]
.questions
.findIndex((q) => {
return (q.prompt === question);
}));
// Check if the question inside the poll is in the map
if (questionIndex !== -1) {
// Poll and question exist. Add response to existing question
pollIdToOccurrenceMap[pollId]
.questions[questionIndex]
.responses
.push(response);
}
else {
// Poll is there but question is not. Add prompt and response
pollIdToOccurrenceMap[pollId].questions.push({
prompt: question,
responses: [response],
});
}
// Update timestamp if the new timestamp is earlier
if (pollTime < pollIdToOccurrenceMap[pollId].timestamp) {
pollIdToOccurrenceMap[pollId].timestamp = pollTime;
}
}
});
});
// Flatten map into an array
return Object.values(pollIdToOccurrenceMap);
});
}
/**
* Get poll info (Light)
* @author Yuen Ler Chow
* @instance
* @memberof api.meeting
* @method getPollInfo
* @param opts object containing all arguments
* @param opts.meetingId the Zoom ID of the meeting
* @param opts.pollId the id of the poll
* @returns object with all info about the poll
*/
getPollInfo(opts) {
var _a, _b, _c;
return __awaiter(this, void 0, void 0, function* () {
// Ask Zoom for unprocessed poll data
const response = yield this.visitEndpoint({
path: `/meetings/${opts.meetingId}/polls/${opts.pollId}`,
action: 'get the poll info',
method: 'GET',
errorMap: {
4400: 'Meeting polls are disabled on your account.',
3161: 'Meeting hosting and scheduling capabilities are not allowed for your user account.',
404: 'We could not find the poll.',
},
});
try {
// Parse and format poll info
const pollInfo = {
// Add the poll id
pollId: response.id,
// Convert string status to enum
pollStatus: ((_a = {
notstart: ZoomPollStatus_1.default.NotStart,
started: ZoomPollStatus_1.default.Started,
sharing: ZoomPollStatus_1.default.Sharing,
ended: ZoomPollStatus_1.default.Ended,
}[response.status]) !== null && _a !== void 0 ? _a : ZoomPollStatus_1.default.NotStart),
// Check if poll is anonymous
anonymous: !!response.anonymous,
// Convert string type to enum
pollType: ((_b = {
1: ZoomPollType_1.default.Poll,
2: ZoomPollType_1.default.AdvancedPoll,
3: ZoomPollType_1.default.Quiz,
}[response.type]) !== null && _b !== void 0 ? _b : ZoomPollType_1.default.Poll),
// Add the title
title: response.title,
// Parse and format questions
questions: response.questions.map((question) => {
// Destructure and convert variables to camelCase
const { answer_required: answerRequired, answers, name, right_answers: rightAnswers, type: questionType, case_sensitive: caseSensitive, answer_min_character: answerMinCharacters, answer_max_character: answerMaxCharacters, rating_max_label: ratingMaxLabel, rating_max_value: ratingMaxValue, rating_min_label: ratingMinLabel, rating_min_value: ratingMinValue, show_as_dropdown: showAsDropdown, } = question;
// Set of fields that are common to all question types
const commonFields = {
answerRequired: !!answerRequired,
// trim each answer
answers: ((answers && Array.isArray(answers) && answers.length > 0)
? answers.map((answer) => {
return answer.trim();
})
: []),
name,
rightAnswers,
};
// Add in question type-specific fields
if (questionType === 'single'
|| questionType === 'multiple') {
return Object.assign({ questionAnswerType: (questionType === 'single'
? ZoomPollQuestionAndAnswerType_1.default.SingleChoice
: ZoomPollQuestionAndAnswerType_1.default.MultipleChoice), showAsDropdown: !!showAsDropdown }, commonFields);
}
if (questionType === 'short_answer'
|| questionType === 'long_answer') {
return Object.assign({ questionAnswerType: (questionType === 'short_answer'
? ZoomPollQuestionAndAnswerType_1.default.ShortAnswer
: ZoomPollQuestionAndAnswerType_1.default.LongAnswer), answerMinCharacters: Number.parseInt(answerMinCharacters, 10), answerMaxCharacters: Number.parseInt(answerMaxCharacters, 10) }, commonFields);
}
if (questionType === 'fill_in_the_blank') {
return Object.assign({ questionAnswerType: ZoomPollQuestionAndAnswerType_1.default.FillInTheBlank, caseSensitive }, commonFields);
}
if (questionType === 'rating_scale') {
return Object.assign({ questionAnswerType: ZoomPollQuestionAndAnswerType_1.default.RatingScale, ratingMaxLabel,
ratingMaxValue,
ratingMinLabel,
ratingMinValue }, commonFields);
}
// None of the supported question types. Only return common fields
return Object.assign({ questionAnswerType: ZoomPollQuestionAndAnswerType_1.default.Unknown }, commonFields);
}),
};
return pollInfo;
}
catch (err) {
throw new ZACCLError_1.default({
message: `We encountered an error while parsing Zoom poll information: ${(_c = err.message) !== null && _c !== void 0 ? _c : 'unknown error'}`,
code: ErrorCode_1.default.PollInfoMalformed,
});
}
});
}
/**
* 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. (Light)
* @author Gabe Abrams
* @author Aryan Pandey
* @instance
* @memberof api.meeting
* @method addAltHost
* @param opts object containing all arguments
* @param opts.meetingId the id for the meeting to add hosts to
* @param opts.altHost the email or id of the alt host to
* be added
* @param [opts.meetingObj] Zoom meeting object that needs to be
* updated. Meeting ID is not used to fetch meeting if this object is passed
* @returns updated meeting object after adding alternative host
*/
addAltHost(opts) {
return __awaiter(this, void 0, void 0, function* () {
// Destructure arguments
const { meetingId, altHost, } = opts;
let { meetingObj } = opts;
// Only call get if no meetingObj passed
if (!meetingObj) {
meetingObj = yield this.api.meeting.get({ meetingId });
}
// extract altHosts into an array
const altHosts = (meetingObj.settings.alternative_hosts
// Split into individual hosts
.split(',')
// Remove whitespace around hosts
.map((host) => {
return host.trim();
}));
// add as altHost only if not already present
if (altHosts.indexOf(altHost) < 0) {
altHosts.push(altHost);
meetingObj.settings.alternative_hosts = altHosts.join(',');
try {
yield this.api.meeting.update({ meetingId, meetingObj });
}
catch (err) {
// Handle deactivated user case
const someUserHasBeenDeactivated = (err.code === 'ZOOM400-1115');
const deactivatedUserIsCurrentUser = (err.message.toLowerCase().includes(altHost.toLowerCase()));
if (someUserHasBeenDeactivated) {
if (deactivatedUserIsCurrentUser) {
// Cannot add as alt host because the user is deactivated
throw new ZACCLError_1.default({
message: `We could not add "${altHost}" to the list of alt-hosts for this meeting because that account has been deactivated.`,
code: ErrorCode_1.default.NotAddedBecauseDeactivated,
});
}
// Someone else on the list has been deactivated
// Wipe the list and try again
meetingObj.settings.alternative_hosts = altHost;
yield this.api.meeting.update({ meetingId, meetingObj });
}
}
}
// return updated meeting object
return meetingObj;
});
}
/**
* Get meeting transcript (Medium)
* @author Gabe Abrams
* @instance
* @memberof api.meeting
* @method getTranscript
* @param opts object containing all arguments
* @param opts.meetingId the Zoom ID of the meeting (or UUID of a past meeting instance)
* @returns meeting transcript
*/
getTranscript(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/meetings/${opts.meetingId}/transcript`,
action: 'get the meeting transcript',
method: 'GET',
errorMap: {
400: 'Invalid meeting ID',
403: 'You do not have permission to access the transcript for this meeting',
404: {
3322: 'The meeting transcript does not exist',
},
},
});
});
}
/**
* Get list of participants in a past meeting (Medium)
* @author Gabe Abrams
* @instance
* @memberof api.meeting
* @method listPastMeetingParticipants
* @param opts object containing all arguments
* @param opts.meetingId the Zoom UUID of the past meeting instance
* @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 past meeting participants
*/
listPastMeetingParticipants(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/past_meetings/${opts.meetingId}/participants`,
action: 'get the list of participants in a past meeting',
method: 'GET',
params: {
page_size: 300, // max allowed page size
},
itemKey: 'participants',
onNewPage: opts.onNewPage,
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
errorMap: {
400: {
200: 'You need a paid account to access the participant list of a past meeting.',
12702: 'You are not allowed to access information about meetings that occurred more than 1 year ago.',
},
404: {
3001: 'The meeting ID is invalid or the meeting has not ended.',
},
},
});
});
}
/**
* Get a meeting activities report (Heavy)
* @author Gabe Abrams
* @instance
* @memberof api.meeting
* @method getActivitiesReport
* @param opts object containing all arguments
* @param opts.meetingId the Zoom UUID of the meeting
* @param opts.startTimestamp the start of the time range to get activities for, in ms since epoch
* @param [opts.endTimestamp] the end of the time range to get activities for, in ms since epoch.
* If not provided, defaults to startTimestamp + 24 hours
* @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 past meeting participants
*/
getActivitiesReport(opts) {
return __awaiter(this, void 0, void 0, function* () {
// Destructure opts
const { meetingId, startTimestamp, } = opts;
// Determine end timestamp
const endTimestamp = (opts.endTimestamp
|| (startTimestamp + 24 * 60 * 60 * 1000) // default to 24 hours after start time
);
// Convert timestamps to yyyy-MM-dd format
const startYear = new Date(startTimestamp).getUTCFullYear();
const startMonth = String(new Date(startTimestamp).getUTCMonth() + 1).padStart(2, '0');
const startDay = String(new Date(startTimestamp).getUTCDate()).padStart(2, '0');
const endYear = new Date(endTimestamp).getUTCFullYear();
const endMonth = String(new Date(endTimestamp).getUTCMonth() + 1).padStart(2, '0');
const endDay = String(new Date(endTimestamp).getUTCDate()).padStart(2, '0');
const from = `${startYear}-${startMonth}-${startDay}`;
const to = `${endYear}-${endMonth}-${endDay}`;
// Call endpoint
return this.visitEndpoint({
path: '/report/meeting_activities',
action: 'get a meeting activities report',
method: 'GET',
params: {
page_size: 300,
meeting_number: meetingId,
from,
to,
activity_type: 'All Activities',
},
itemKey: 'meeting_activity_logs',
onNewPage: opts.onNewPage,
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
errorMap: {
400: 'Bad request',
403: 'Not allowed',
404: 'Meeting not found',
},
});
});
}
/**
* Get a participant report for a meeting (Heavy)
* @author Gabe Abrams
* @instance
* @memberof api.meeting
* @method getParticipantReport
* @param opts object containing all arguments
* @param opts.meetingId the Zoom UUID of the meeting
* @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 meeting participants with report details
*/
getParticipantReport(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/report/meetings/${opts.meetingId}/participants`,
action: 'get a participant report for a meeting',
method: 'GET',
params: {
page_size: 300, // max allowed page size
},
itemKey: 'participants',
onNewPage: opts.onNewPage,
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
errorMap: {
400: {
1010: 'User does not exist or does not belong to this account',
12702: 'You are not allowed to access information about meetings that occurred more than 1 year ago.',
200: 'You do not have the permission create a meeting participants report',
},
404: {
3001: 'The meeting ID is invalid or the meeting has not ended.',
},
},
});
});
}
/**
* Get a question and answer report for a meeting (Heavy)
* @author Gabe Abrams
* @instance
* @memberof api.meeting
* @method getQAReport
* @param opts object containing all arguments
* @param opts.meetingId the Zoom UUID of the meeting
* @returns list of questions and answers from the meeting
*/
getQAReport(opts) {
return __awaiter(this, void 0, void 0, function* () {
return this.visitEndpoint({
path: `/report/meetings/${opts.meetingId}/qa`,
action: 'get a question and answer report for a meeting',
method: 'GET',
itemKey: 'questions',
errorMap: {
400: {
200: 'You are not allowed to create a meeting question and answer report',
},
404: {
3001: 'The meeting ID is invalid or the meeting has not ended.',
},
},
});
});
}
}
/*------------------------------------------------------------------------*/
/* Export */
/*------------------------------------------------------------------------*/
exports.default = ECatMeeting;
//# sourceMappingURL=ECatMeeting.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>