This method allows you to show a notification to the user. The most common example of use is to report an error/success.
Platforms
- B2B-Web
Method params
| Parameter name | Parameter type | Required | Parameter description |
|---|---|---|---|
| type | info | warning | error | success | yes | Notification type |
| message | string | yes | Notification header. For example: "An error has occurred". |
| description | string | no | The body of the notification, which should describe the details of the notification |
Return value
If successful, the method will return a JSON object containing a single
success field:json{ "success": true }
Usage examples
typescriptimport bridge from '@open-condo/bridge' bridge.send('CondoWebAppShowNotification', { type: 'error', message: 'Error occurred during integration', description: 'Your account does not have the email address required to connect the mini-application' })
