mod/lti/amd/src/external_registration_return.js

  1. // This file is part of Moodle - http://moodle.org/
  2. //
  3. // Moodle is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU General Public License as published by
  5. // the Free Software Foundation, either version 3 of the License, or
  6. // (at your option) any later version.
  7. //
  8. // Moodle is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16. /**
  17.  * Handles the return params from the external registration page after it
  18.  * redirects back to Moodle.
  19.  *
  20.  * See also: mod/lti/externalregistrationreturn.php
  21.  *
  22.  * @module     mod_lti/external_registration_return
  23.  * @copyright  2015 Ryan Wyllie <ryan@moodle.com>
  24.  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25.  * @since      3.1
  26.  */
  27. define([], function() {
  28.     return {
  30.         /**
  31.          * If this was rendered in an iframe then trigger the external registration
  32.          * complete behaviour in the parent page and provide the params returned from
  33.          * the external registration page.
  34.          *
  35.          * @param {String} message The registration message from the external registration page
  36.          * @param {String} error The registration error message from the external registration page, if
  37.          *                     there was an error.
  38.          * @param {Integer} id The tool proxy id for the external registration.
  39.          * @param {String} status Whether the external registration was successful or not.
  40.          */
  41.         init: function(message, error, id, status) {
  42.             if (window.parent) {
  43.                 window.parent.triggerExternalRegistrationComplete({
  44.                     message: message,
  45.                     error: error,
  46.                     id: id,
  47.                     status: status
  48.                 });
  49.             }
  50.         }
  51.     };
  52. });