caccl-api
Version:
A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.
683 lines (656 loc) • 49 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>ECatCourse/ECatApp.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">CACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.account.html">api.account</a><ul class='methods'><li data-type='method'><a href="api.account.html#get">get</a></li><li data-type='method'><a href="api.account.html#list">list</a></li><li data-type='method'><a href="api.account.html#listAdmins">listAdmins</a></li><li data-type='method'><a href="api.account.html#listCourses">listCourses</a></li></ul></li><li><a href="api.conversation.html">api.conversation</a><ul class='methods'><li data-type='method'><a href="api.conversation.html#create">create</a></li></ul></li><li><a href="api.course.html">api.course</a><ul class='methods'><li data-type='method'><a href="api.course.html#get">get</a></li><li data-type='method'><a href="api.course.html#getUser">getUser</a></li><li data-type='method'><a href="api.course.html#listDesignerEnrollments">listDesignerEnrollments</a></li><li data-type='method'><a href="api.course.html#listDesigners">listDesigners</a></li><li data-type='method'><a href="api.course.html#listEnrollments">listEnrollments</a></li><li data-type='method'><a href="api.course.html#listObserverEnrollments">listObserverEnrollments</a></li><li data-type='method'><a href="api.course.html#listObservers">listObservers</a></li><li data-type='method'><a href="api.course.html#listStudentEnrollments">listStudentEnrollments</a></li><li data-type='method'><a href="api.course.html#listStudents">listStudents</a></li><li data-type='method'><a href="api.course.html#listTAs">listTAs</a></li><li data-type='method'><a href="api.course.html#listTeachers">listTeachers</a></li><li data-type='method'><a href="api.course.html#listTeachingTeamMemberEnrollments">listTeachingTeamMemberEnrollments</a></li><li data-type='method'><a href="api.course.html#listTeachingTeamMembers">listTeachingTeamMembers</a></li><li data-type='method'><a href="api.course.html#listUsers">listUsers</a></li><li data-type='method'><a href="api.course.html#migrateContent">migrateContent</a></li><li data-type='method'><a href="api.course.html#updatePublishState">updatePublishState</a></li></ul></li><li><a href="api.course.analytics.html">api.course.analytics</a><ul class='methods'><li data-type='method'><a href="api.course.analytics.html#getStudentMessagingData">getStudentMessagingData</a></li><li data-type='method'><a href="api.course.analytics.html#getStudentParticipationData">getStudentParticipationData</a></li><li data-type='method'><a href="api.course.analytics.html#getStudentSummary">getStudentSummary</a></li><li data-type='method'><a href="api.course.analytics.html#listAssignmentSummaries">listAssignmentSummaries</a></li><li data-type='method'><a href="api.course.analytics.html#listDailyActivitySummaries">listDailyActivitySummaries</a></li><li data-type='method'><a href="api.course.analytics.html#listStudentSummaries">listStudentSummaries</a></li></ul></li><li><a href="api.course.announcement.html">api.course.announcement</a><ul class='methods'><li data-type='method'><a href="api.course.announcement.html#create">create</a></li><li data-type='method'><a href="api.course.announcement.html#list">list</a></li></ul></li><li><a href="api.course.app.html">api.course.app</a><ul class='methods'><li data-type='method'><a href="api.course.app.html#addByClientId">addByClientId</a></li><li data-type='method'><a href="api.course.app.html#addByXML">addByXML</a></li><li data-type='method'><a href="api.course.app.html#addRedirect">addRedirect</a></li><li data-type='method'><a href="api.course.app.html#get">get</a></li><li data-type='method'><a href="api.course.app.html#getAssignmentLaunchURL">getAssignmentLaunchURL</a></li><li data-type='method'><a href="api.course.app.html#getMetadata">getMetadata</a></li><li data-type='method'><a href="api.course.app.html#getNavLaunchURL">getNavLaunchURL</a></li><li data-type='method'><a href="api.course.app.html#hideFromNav">hideFromNav</a></li><li data-type='method'><a href="api.course.app.html#list">list</a></li><li data-type='method'><a href="api.course.app.html#moveToTopOfNavMenu">moveToTopOfNavMenu</a></li><li data-type='method'><a href="api.course.app.html#remove">remove</a></li><li data-type='method'><a href="api.course.app.html#showInNav">showInNav</a></li><li data-type='method'><a href="api.course.app.html#updateMetadata">updateMetadata</a></li></ul></li><li><a href="api.course.assignment.html">api.course.assignment</a><ul class='methods'><li data-type='method'><a href="api.course.assignment.html#create">create</a></li><li data-type='method'><a href="api.course.assignment.html#createOverride">createOverride</a></li><li data-type='method'><a href="api.course.assignment.html#createSubmissionComment">createSubmissionComment</a></li><li data-type='method'><a href="api.course.assignment.html#createTextSubmission">createTextSubmission</a></li><li data-type='method'><a href="api.course.assignment.html#createURLSubmission">createURLSubmission</a></li><li data-type='method'><a href="api.course.assignment.html#delete">delete</a></li><li data-type='method'><a href="api.course.assignment.html#deleteOverride">deleteOverride</a></li><li data-type='method'><a href="api.course.assignment.html#get">get</a></li><li data-type='method'><a href="api.course.assignment.html#getOverride">getOverride</a></li><li data-type='method'><a href="api.course.assignment.html#getSubmission">getSubmission</a></li><li data-type='method'><a href="api.course.assignment.html#list">list</a></li><li data-type='method'><a href="api.course.assignment.html#listAllSubmissions">listAllSubmissions</a></li><li data-type='method'><a href="api.course.assignment.html#listGradeableStudents">listGradeableStudents</a></li><li data-type='method'><a href="api.course.assignment.html#listOverrides">listOverrides</a></li><li data-type='method'><a href="api.course.assignment.html#listSubmissions">listSubmissions</a></li><li data-type='method'><a href="api.course.assignment.html#update">update</a></li><li data-type='method'><a href="api.course.assignment.html#updateGrade">updateGrade</a></li><li data-type='method'><a href="api.course.assignment.html#updateGrades">updateGrades</a></li><li data-type='method'><a href="api.course.assignment.html#updateOverride">updateOverride</a></li></ul></li><li><a href="api.course.assignmentGroup.html">api.course.assignmentGroup</a><ul class='methods'><li data-type='method'><a href="api.course.assignmentGroup.html#create">create</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#delete">delete</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#get">get</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#list">list</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#update">update</a></li></ul></li><li><a href="api.course.discussionTopic.html">api.course.discussionTopic</a><ul class='methods'><li data-type='method'><a href="api.course.discussionTopic.html#create">create</a></li><li data-type='method'><a href="api.course.discussionTopic.html#delete">delete</a></li><li data-type='method'><a href="api.course.discussionTopic.html#list">list</a></li><li data-type='method'><a href="api.course.discussionTopic.html#listEntries">listEntries</a></li><li data-type='method'><a href="api.course.discussionTopic.html#updatePublishState">updatePublishState</a></li></ul></li><li><a href="api.course.file.html">api.course.file</a><ul class='methods'><li data-type='method'><a href="api.course.file.html#list">list</a></li></ul></li><li><a href="api.course.folder.html">api.course.folder</a><ul class='methods'><li data-type='method'><a href="api.course.folder.html#list">list</a></li></ul></li><li><a href="api.course.gradebookColumn.html">api.course.gradebookColumn</a><ul class='methods'><li data-type='method'><a href="api.course.gradebookColumn.html#create">create</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#delete">delete</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#get">get</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#list">list</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#listEntries">listEntries</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#update">update</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#updateEntries">updateEntries</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#updateEntry">updateEntry</a></li></ul></li><li><a href="api.course.group.html">api.course.group</a><ul class='methods'><li data-type='method'><a href="api.course.group.html#create">create</a></li><li data-type='method'><a href="api.course.group.html#delete">delete</a></li><li data-type='method'><a href="api.course.group.html#get">get</a></li><li data-type='method'><a href="api.course.group.html#listUsers">listUsers</a></li><li data-type='method'><a href="api.course.group.html#updateMembers">updateMembers</a></li></ul></li><li><a href="api.course.groupSet.html">api.course.groupSet</a><ul class='methods'><li data-type='method'><a href="api.course.groupSet.html#create">create</a></li><li data-type='method'><a href="api.course.groupSet.html#delete">delete</a></li><li data-type='method'><a href="api.course.groupSet.html#get">get</a></li><li data-type='method'><a href="api.course.groupSet.html#list">list</a></li><li data-type='method'><a href="api.course.groupSet.html#listGroups">listGroups</a></li></ul></li><li><a href="api.course.module.html">api.course.module</a><ul class='methods'><li data-type='method'><a href="api.course.module.html#list">list</a></li></ul></li><li><a href="api.course.navMenuItem.html">api.course.navMenuItem</a><ul class='methods'><li data-type='method'><a href="api.course.navMenuItem.html#list">list</a></li><li data-type='method'><a href="api.course.navMenuItem.html#update">update</a></li></ul></li><li><a href="api.course.page.html">api.course.page</a><ul class='methods'><li data-type='method'><a href="api.course.page.html#create">create</a></li><li data-type='method'><a href="api.course.page.html#delete">delete</a></li><li data-type='method'><a href="api.course.page.html#get">get</a></li><li data-type='method'><a href="api.course.page.html#list">list</a></li><li data-type='method'><a href="api.course.page.html#update">update</a></li></ul></li><li><a href="api.course.quiz.html">api.course.quiz</a><ul class='methods'><li data-type='method'><a href="api.course.quiz.html#create">create</a></li><li data-type='method'><a href="api.course.quiz.html#createEssayQuestion">createEssayQuestion</a></li><li data-type='method'><a href="api.course.quiz.html#createMultipleChoiceQuestion">createMultipleChoiceQuestion</a></li><li data-type='method'><a href="api.course.quiz.html#createShortAnswerQuestion">createShortAnswerQuestion</a></li><li data-type='method'><a href="api.course.quiz.html#createSubmission">createSubmission</a></li><li data-type='method'><a href="api.course.quiz.html#delete">delete</a></li><li data-type='method'><a href="api.course.quiz.html#get">get</a></li><li data-type='method'><a href="api.course.quiz.html#getQuizStudentReport">getQuizStudentReport</a></li><li data-type='method'><a href="api.course.quiz.html#getSubmission">getSubmission</a></li><li data-type='method'><a href="api.course.quiz.html#list">list</a></li><li data-type='method'><a href="api.course.quiz.html#listQuestions">listQuestions</a></li><li data-type='method'><a href="api.course.quiz.html#listSubmissions">listSubmissions</a></li><li data-type='method'><a href="api.course.quiz.html#update">update</a></li><li data-type='method'><a href="api.course.quiz.html#updateQuestionGrades">updateQuestionGrades</a></li></ul></li><li><a href="api.course.rubric.html">api.course.rubric</a><ul class='methods'><li data-type='method'><a href="api.course.rubric.html#createFreeFormGradingRubricInAssignment">createFreeFormGradingRubricInAssignment</a></li><li data-type='method'><a href="api.course.rubric.html#get">get</a></li><li data-type='method'><a href="api.course.rubric.html#list">list</a></li></ul></li><li><a href="api.course.section.html">api.course.section</a><ul class='methods'><li data-type='method'><a href="api.course.section.html#get">get</a></li><li data-type='method'><a href="api.course.section.html#list">list</a></li></ul></li><li><a href="api.enrollmentTerm.html">api.enrollmentTerm</a></li><li><a href="api.other.html">api.other</a><ul class='methods'><li data-type='method'><a href="api.other.html#endpoint">endpoint</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#listCourses">listCourses</a></li><li data-type='method'><a href="api.user.html#listEmails">listEmails</a></li><li data-type='method'><a href="api.user.html#search">search</a></li></ul></li><li><a href="api.user.self.html">api.user.self</a><ul class='methods'><li data-type='method'><a href="api.user.self.html#getProfile">getProfile</a></li><li data-type='method'><a href="api.user.self.html#listCourses">listCourses</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#DateHandlingType">DateHandlingType</a></li><li><a href="global.html#dayOfWeekToNumber">dayOfWeekToNumber</a></li></ul>
</nav>
<div id="main">
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
/**
* Functions for interacting with external LTI apps within courses
* @namespace api.course.app
*/
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
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 __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
// Import caccl
var caccl_error_1 = __importDefault(require("caccl-error"));
// Import shared classes
var EndpointCategory_1 = __importDefault(require("../../shared/EndpointCategory"));
// Import shared types
var ErrorCode_1 = __importDefault(require("../../shared/types/ErrorCode"));
// Import shared constants
var API_PREFIX_1 = __importDefault(require("../../shared/constants/API_PREFIX"));
// Endpoint category
var ECatApp = /** @class */ (function (_super) {
__extends(ECatApp, _super);
function ECatApp() {
return _super !== null && _super.apply(this, arguments) || this;
}
/*------------------------------------------------------------------------*/
/* Endpoints: */
/*------------------------------------------------------------------------*/
/**
* Gets the list of apps installed into a course
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method list
* @param {object} [opts] object containing all arguments
* @param {number} [opts.courseId=default course id] Canvas course Id to query
* @param {boolean} [opts.excludeParents] If true, excludes tools
* installed in all accounts above the current context
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasExternalTool[]>} list of external tools {@link https://canvas.instructure.com/doc/api/external_tools.html}
*/
ECatApp.prototype.list = function (opts, config) {
var _a;
if (opts === void 0) { opts = {}; }
return __awaiter(this, void 0, void 0, function () {
var params;
return __generator(this, function (_b) {
params = (opts.excludeParents
? { include_parents: false }
: { include_parents: true });
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'get the list of apps installed into a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/external_tools"),
method: 'GET',
params: params,
})];
});
});
};
/**
* Gets info on a single LTI tool
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method get
* @param {object} opts object containing all arguments
* @param {number} opts.appId The LTI app Id to get
* @param {number} [opts.courseId=default course id] Canvas course Id
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasExternalTool>} Canvas external tool {@link https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.show}
*/
ECatApp.prototype.get = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'get info on a specific LTI app in a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/external_tools/").concat(opts.appId),
method: 'GET',
})];
});
});
};
/**
* Adds an LTi app by its XML to a Canvas course
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method addByXML
* @param {object} opts object containing all arguments
* @param {string} opts.name The app name (for settings app list)
* @param {string} opts.key Installation consumer key
* @param {string} opts.secret Installation consumer secret
* @param {string} opts.xml XML configuration file, standard LTI format
* @param {string} opts.description A human-readable description of the
* app
* @param {number} [opts.courseId=default course id] Canvas course Id to install into
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasExternalTool>} Canvas external tool {@link https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.show}
*/
ECatApp.prototype.addByXML = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
// Add the app
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'add an LTI app to a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/external_tools"),
method: 'POST',
params: {
name: opts.name,
consumer_key: opts.key,
shared_secret: opts.secret,
config_type: 'by_xml',
config_xml: opts.xml,
},
})];
});
});
};
/**
* Adds an LTi app by its clientId to a Canvas course
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method addByClientId
* @param {object} opts object containing all arguments
* @param {string} opts.clientId the client id of the app that is associated
* with the Canvas instance containing the course of interest
* @param {number} [opts.courseId=default course id] Canvas course Id to install into
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasExternalTool>} Canvas external tool {@link https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.show}
*/
ECatApp.prototype.addByClientId = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
// Add the app
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'add an LTI app to a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/external_tools"),
method: 'POST',
params: {
client_id: opts.clientId,
},
})];
});
});
};
/**
* Add a redirect app to the navigation menu
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method addRedirect
* @param {object} opts object containing all arguments
* @param {string} opts.name the name of the app as it shows up in the nav
* menu
* @param {string} opts.url the url to direct the course to when they click the
* redirect app
* @param {boolean} [opts.hiddenFromStudents] if true, hide the link from
* students
* @param {boolean} [opts.dontOpenInNewTab] if true, redirect does not open in
* another tab
* @param {number} [opts.courseId=default course id] Canvas course Id to install into
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasExternalTool>} Canvas external tool {@link https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.show}
*/
ECatApp.prototype.addRedirect = function (opts, config) {
return __awaiter(this, void 0, void 0, function () {
var xml;
return __generator(this, function (_a) {
xml = "\n<cartridge_basiclti_link xmlns=\"http://www.imsglobal.org/xsd/imslticc_v1p0\" xmlns:blti=\"http://www.imsglobal.org/xsd/imsbasiclti_v1p0\" xmlns:lticm=\"http://www.imsglobal.org/xsd/imslticm_v1p0\" xmlns:lticp=\"http://www.imsglobal.org/xsd/imslticp_v1p0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0p1.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd\">\n <blti:title>Redirect Tool</blti:title>\n <blti:description>Redirect: ".concat(opts.name, "</blti:description>\n <blti:launch_url>https://www.edu-apps.org/redirect</blti:launch_url>\n <blti:icon>https://www.edu-apps.org/assets/lti_redirect_engine/redirect_icon.png</blti:icon>\n <blti:custom>\n <lticm:property name=\"url\">").concat(opts.url, "</lticm:property>\n </blti:custom>\n <blti:extensions platform=\"canvas.instructure.com\">\n <lticm:options name=\"course_navigation\">\n <lticm:property name=\"enabled\">true</lticm:property>\n <lticm:property name=\"visibility\">").concat(opts.hiddenFromStudents ? 'admins' : 'members', "</lticm:property>\n <lticm:property name=\"windowTarget\">").concat(opts.dontOpenInNewTab ? '_self' : '_blank', "</lticm:property>\n </lticm:options>\n <lticm:property name=\"icon_url\">https://www.edu-apps.org/assets/lti_redirect_engine/redirect_icon.png</lticm:property>\n <lticm:property name=\"link_text\"/>\n <lticm:property name=\"privacy_level\">anonymous</lticm:property>\n <lticm:property name=\"tool_id\">redirect ").concat(opts.name, "</lticm:property>\n </blti:extensions>\n</cartridge_basiclti_link>\n ");
// Add the app
return [2 /*return*/, this.api.course.app.addByXML({
name: opts.name,
key: 'N/A',
secret: 'N/A',
xml: xml,
}, config)];
});
});
};
/**
* Makes an app visible in the left-hand navigation menu if it was hidden
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method showInNav
* @param {object} opts object containing all arguments
* @param {number} opts.appId The LTI app Id to make visible
* @param {boolean} [opts.putAtTop] if true, put the app at the top of
* the left-hand nav menu
* @param {number} [opts.courseId=default course id] Canvas course Id for the
* course containing the app
* @returns {Promise<CanvasTab>} Canvas tab {@link https://canvas.instructure.com/doc/api/tabs.html}
*/
ECatApp.prototype.showInNav = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'show an LTI app in the left-hand nav of a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/tabs/context_external_tool_").concat(opts.appId),
method: 'PUT',
params: {
hidden: false,
position: (opts.putAtTop
? 2
: undefined),
},
})];
});
});
};
/**
* Hides an app from the left-hand navigation menu if it was visible
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method hideFromNav
* @param {object} opts object containing all arguments
* @param {number} opts.appId The LTI app Id to hide
* @param {number} [opts.courseId=default course id] Canvas course Id for the
* course containing the app
* @returns {Promise<CanvasTab>} Canvas tab {@link https://canvas.instructure.com/doc/api/tabs.html}
*/
ECatApp.prototype.hideFromNav = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'hide an LTI app from the left-hand nav of a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/tabs/context_external_tool_").concat(opts.appId),
method: 'PUT',
params: {
hidden: true,
},
})];
});
});
};
/**
* Removes an LTI app from a Canvas course
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method remove
* @param {object} opts object containing all arguments
* @param {number} opts.appId The LTI app Id to remove
* @param {number} [opts.courseId=default course id] Canvas course Id to
* remove app from
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasExternalTool>} Canvas external tool {@link https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.show}
*/
ECatApp.prototype.remove = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'remove an LTI app from a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/external_tools/").concat(opts.appId),
method: 'DELETE',
})];
});
});
};
/*------------------------------------------------------------------------*/
/* Metadata */
/*------------------------------------------------------------------------*/
/**
* Gets the metadata for an LTI app in a course. Note: this endpoint requires
* that the app have a custom parameter called 'metadata_id' with an
* identifier that we will use to refer to the metadata. If each installation
* of an app will have its own metadata, each installation should have a
* different metadata_id. If all installations share the same metadata, they
* should all have the same metadata_id. When getting metadata, we return the
* metadata for the first app we find that has this metadata_id.
* Also note that the variable is 'metadata_id' all lowercase because launch
* params are made lowercase.
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method getMetadata
* @param {object} opts object containing all arguments
* @param {number} opts.metadata_id metadata identifier (see endpoint
* description)
* @param {number} [opts.courseId=default course id] Canvas course Id that
* holds the app
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<object>} the metadata for the first app that has the given
* metadata_id
*/
ECatApp.prototype.getMetadata = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var apps, firstAppWithMetadataId, i, metadata;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.api.course.app.list({
courseId: ((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId),
}, config)];
case 1:
apps = _b.sent();
for (i = 0; i < apps.length; i++) {
if (apps[i].custom_fields
&& apps[i].custom_fields.metadata_id
&& apps[i].custom_fields.metadata_id === opts.metadata_id) {
// Found an app with this metadata id!
firstAppWithMetadataId = apps[i];
break;
}
}
if (!firstAppWithMetadataId) {
// No apps with this metadata_id could be found! Throw error
throw new caccl_error_1.default({
message: 'We could not find any apps with the given metadata id.',
code: ErrorCode_1.default.NoAppWithMetadataFound,
});
}
// Check if metadata is empty
if (!firstAppWithMetadataId.custom_fields.metadata
|| firstAppWithMetadataId.custom_fields.metadata === ''
|| firstAppWithMetadataId.custom_fields.metadata.trim().length === 0) {
// Metadata empty
return [2 /*return*/, Promise.resolve({})];
}
// Parse metadata
try {
metadata = JSON.parse(firstAppWithMetadataId.custom_fields.metadata);
return [2 /*return*/, metadata];
}
catch (err) {
// Metadata malformed
throw new caccl_error_1.default({
message: 'Metadata was malformed.',
code: ErrorCode_1.default.MetadataMalformed,
});
}
return [2 /*return*/];
}
});
});
};
/**
* Updates the metadata for an LTI app in a course. Note: this endpoint requires
* that the app have a custom parameter called 'metadata_id' with an
* identifier that we will use to refer to the metadata. If each installation
* of an app will have its own metadata, each installation should have a
* different metadata_id. If all installations share the same metadata, they
* should all have the same metadata_id. When getting metadata, we return the
* metadata for the first app we find that has this metadata_id.
* Also note that the variable is 'metadata_id' all lowercase because launch
* params are made lowercase.
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method updateMetadata
* @param {object} opts object containing all arguments
* @param {number} opts.metadata_id metadata identifier (see endpoint
* description)
* @param {object} [opts.metadata={}] json metadata object
* @param {number} [opts.courseId=default course id] Canvas course Id that holds the app
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasExternalTool[]>} Array of external tools (the apps that were updated) {@link https://canvas.instructure.com/doc/api/external_tools.html#method.external_tools.show}
*/
ECatApp.prototype.updateMetadata = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var metadata, apps, appsToUpdate;
var _this = this;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
metadata = JSON.stringify(opts.metadata || {});
return [4 /*yield*/, this.api.course.app.list({
courseId: ((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId),
}, config)];
case 1:
apps = _b.sent();
appsToUpdate = apps.filter(function (app) {
return (app.custom_fields
&& app.custom_fields.metadata_id
&& app.custom_fields.metadata_id === opts.metadata_id);
});
if (appsToUpdate.length === 0) {
// No apps with this metadata_id could be found! Throw arror
throw new caccl_error_1.default({
message: 'We could not find any apps with the given metadata id.',
code: ErrorCode_1.default.NoAppsToUpdateMetadata,
});
}
// Update all app metadata objects in parallel
return [2 /*return*/, Promise.all(appsToUpdate.map(function (app) {
var _a;
// Perform merge for custom fields so we don't lose other custom vals
var params = {
'custom_fields[metadata]': metadata,
};
Object.keys(app.custom_fields).forEach(function (customPropName) {
// Don't let old metadata overwrite new metadata
if (customPropName === 'metadata') {
return;
}
var customVal = app.custom_fields[customPropName];
params["custom_fields[".concat(customPropName, "]")] = customVal;
});
// Update custom params
return _this.visitEndpoint({
config: config,
action: 'update metadata for an LTI app in a course',
params: params,
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : _this.defaultCourseId, "/external_tools/").concat(app.id),
method: 'PUT',
});
}))];
}
});
});
};
/*------------------------------------------------------------------------*/
/* Sessionless Launch */
/*------------------------------------------------------------------------*/
/**
* Gets a sessionless navigation LTI launch URL
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method getNavLaunchURL
* @param {object} opts object containing all arguments
* @param {number} opts.appId The LTI app Id to get a launch URL for
* @param {number} [opts.courseId=default course id] Canvas course Id that
* holds the app
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<string>} launch URL
*/
ECatApp.prototype.getNavLaunchURL = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.visitEndpoint({
config: config,
action: 'get a sessionless navigation LTI launch url for an app in a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/external_tools/sessionless_launch"),
method: 'GET',
params: {
id: opts.appId,
},
})];
case 1:
response = _b.sent();
return [2 /*return*/, response.url];
}
});
});
};
/**
* Gets a sessionless navigation LTI launch URL
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method getAssignmentLaunchURL
* @param {object} opts object containing all arguments
* @param {number} opts.appId The LTI app Id to get a launch URL for
* @param {number} opts.assignmentId the Canvas assignment id to launch
* @param {number} [opts.courseId=default course id] Canvas course Id that holds the app
* from
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<string>} launch url
*/
ECatApp.prototype.getAssignmentLaunchURL = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.visitEndpoint({
config: config,
action: 'get a sessionless assignment LTI launch url for an app in a course',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/external_tools/sessionless_launch"),
method: 'GET',
params: {
id: opts.appId,
assignment_id: opts.assignmentId,
launch_type: 'assessment',
},
})];
case 1:
response = _b.sent();
return [2 /*return*/, response.url];
}
});
});
};
/*------------------------------------------------------------------------*/
/* Navigation */
/*------------------------------------------------------------------------*/
/**
* Move an app near the top of the nav menu and make sure it's visible
* @author Gabe Abrams
* @memberof api.course.app
* @instance
* @async
* @method moveToTopOfNavMenu
* @param {object} opts object containing all arguments
* @param {number} opts.appId The LTI app Id to make visible and move near
* the top of the nav menu
* @param {number} [opts.courseId=default course id] Canvas course Id that
* holds the app
* @param {APIConfig} [config] custom configuration for this specific endpoint
* call (overwrites defaults that were included when api was initialized)
* @returns {Promise<CanvasTab>} Canvas tab {@link https://canvas.instructure.com/doc/api/tabs.html#Tab}
*/
ECatApp.prototype.moveToTopOfNavMenu = function (opts, config) {
var _a;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
return [2 /*return*/, this.visitEndpoint({
config: config,
action: 'move an app near the top of the nav menu and make sure it\'s visible',
path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/tabs/context_external_tool_").concat(opts.appId),
method: 'PUT',
params: {
position: 2,
hidden: false,
},
})];
});
});
};
return ECatApp;
}(EndpointCategory_1.default));
/*------------------------------------------------------------------------*/
/* Export */
/*------------------------------------------------------------------------*/
exports.default = ECatApp;
//# sourceMappingURL=ECatApp.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>