iFrame command showNotification type error

[felipeavilis]

What happened?

IFrame API command showNotification code and documentation says that it has info type, but it does not. Got an error trying too use it.

<button onclick="api.executeCommand('showNotification', {
    title: 'Notification Title ',
    description: 'Notification - info - short',
    uid: 'uid00001',
    type: 'info',
    timeout: 'short' 
})">Notification Test</button>

Platform

• Chrome (or Chromium based)
• Firefox
• Safari
• Other desktop browser
• Android browser
• iOS browser
• Electron app
• Android mobile app
• iOS mobile app
• Custom app using a mobile SDK

Browser / app / sdk version

131.0.6778.265

Relevant log output

[modules/API/API.js] <show-notification>:  Invalid notification type "info". Expecting one of error,normal,success,warning
r                  @ Logger.js:155
show-notification  @ API.js:610
(anônimo)          @ API.js:890
(anônimo)          @ Transport.js:128
emit               @ Transport.js:127
_onMessageReceived @ Transport.js:98
(anônimo)          @ PostMessageTransportBackend.js:43
p                  @ postis.js:57

Reproducibility

• The problem is reproducible on meet.jit.si

More details?

Documentation:

https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-commands#shownotification

Code:

jitsi-meet/react/features/notifications/constants.ts

Line 26 in 9846228

export const NOTIFICATION_TYPE = {

[damencho]

Can you create a PR against https://github.com/jitsi/handbook? Thanks.

[felipeavilis]

Can you create a PR against https://github.com/jitsi/handbook? Thanks.

Sure! The comments in API.js could also be changed imho.

jitsi-meet/modules/API/API.js

Line 593 in 9846228

* @param { string } arg.type - Notification type, either `error`, `info`, `normal`, `success` or `warning`.

[felipeavilis]

PRs created.

handbook - jitsi/handbook#555
jitsi-meet - #15504