[Summary view] [Print] [Text view]

   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/>.
  15  
  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   * @class      external_registration_return
  24   * @package    mod_lti
  25   * @copyright  2015 Ryan Wyllie <ryan@moodle.com>
  26   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   * @since      3.1
  28   */
  29  define([], function() {
  30  
  31      return /** @alias module:mod_lti/external_registration_return */ {
  32  
  33          /**
  34           * If this was rendered in an iframe then trigger the external registration
  35           * complete behaviour in the parent page and provide the params returned from
  36           * the external registration page.
  37           *
  38           * @param {String} message The registration message from the external registration page
  39           * @param {String} error The registration error message from the external registration page, if
  40           *                     there was an error.
  41           * @param {Integer} id The tool proxy id for the external registration.
  42           * @param {String} status Whether the external registration was successful or not.
  43           */
  44          init: function(message, error, id, status) {
  45              if (window.parent) {
  46                  window.parent.triggerExternalRegistrationComplete({
  47                      message: message,
  48                      error: error,
  49                      id: id,
  50                      status: status
  51                  });
  52              }
  53          }
  54      };
  55  });