SWAMPy

✎ CARVE FLESH

EDITING: lti.showAlert.ts

/*
 * Copyright (C) 2018 - present Instructure, Inc.
 *
 * This file is part of Canvas.
 *
 * Canvas is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, version 3 of the License.
 *
 * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */

import $ from '@canvas/rails-flash-notifications'
import {useScope as useI18nScope} from '@canvas/i18n'
import {LtiMessageHandler} from '../lti_message_handler'

const I18n = useI18nScope('ltiMessages')

const showAlert: LtiMessageHandler<{
  body: unknown
  title?: string
  alertType?: string
}> = ({message, responseMessages}) => {
  if (!message.body) {
    responseMessages.sendBadRequestError("Missing required 'body' field")
    return true
  }

const {title, alertType, body} = message
  const contents = typeof body === 'string' ? body : JSON.stringify(body)
  const toolName = title || $('iframe[data-lti-launch]').attr('title') || I18n.t('External Tool')
  const displayMessage = `${toolName}: ${contents}`

switch (alertType || 'success') {
    case 'success':
      $.flashMessageSafe(displayMessage)
      break
    case 'warning':
      $.flashWarningSafe(displayMessage)
      break
    case 'error':
      $.flashErrorSafe(displayMessage)
      break
    default:
      responseMessages.sendBadRequestError("Unsupported value for 'alertType' field")
      return true
  }
  responseMessages.sendSuccess()
  return true
}

export default showAlert

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 __tests__/	DIR	—	2023-09-24 03:36
📄 lti.capabilities.ts	TS	1.2 KB	2023-09-24 03:36	EDIT
📄 lti.enableScrollEvents.ts	TS	1.3 KB	2023-09-24 03:39	EDIT
📄 lti.fetchWindowSize.ts	TS	1.1 KB	2023-09-24 03:36	EDIT
📄 lti.frameResize.ts	TS	1.7 KB	2023-09-24 03:36	EDIT
📄 lti.get_data.ts	TS	1.3 KB	2023-09-24 03:36	EDIT
📄 lti.hideRightSideWrapper.ts	TS	925 B	2023-09-24 03:36	EDIT
📄 lti.put_data.ts	TS	1.7 KB	2023-09-24 03:36	EDIT
📄 lti.removeUnloadMessage.ts	TS	908 B	2023-09-24 03:36	EDIT
📄 lti.resourceImported.ts	TS	968 B	2023-09-24 03:36	EDIT
📄 lti.screenReaderAlert.ts	TS	1.1 KB	2023-09-24 03:36	EDIT
📄 lti.scrollToTop.ts	TS	986 B	2023-09-24 03:36	EDIT
📄 lti.setUnloadMessage.ts	TS	988 B	2023-09-24 03:36	EDIT
📄 lti.showAlert.ts	TS	1.8 KB	2023-09-24 03:36	EDIT
📄 lti.showModuleNavigation.ts	TS	1 KB	2023-09-24 03:36	EDIT
📄 requestFullWindowLaunch.ts	TS	4.1 KB	2023-09-24 03:39	EDIT
📄 toggleCourseNavigationMenu.ts	TS	933 B	2023-09-24 03:36	EDIT