CondoWebAppUpdateProgressBar

This method allows you to update a previously created progress bar notification.

Platforms

  • B2B-Web

Method params

Parameter nameParameter typeRequiredParameter description
barIdstringyesProgress bar ID
dataJSONyesData to update. Any field from the ones indicated in the notification creation can be updated as well as the numeric progress fields

Return value

If successful, the method will return a JSON object containing a single updated field:
json
{ "updated": true }

Usage example

typescript
import bridge from '@open-condo/bridge' // Update progress bridge.send('CondoWebAppUpdateProgressBar', { barId: '3f4714ab-30f9-4bd4-b91b-67e9c5b7f1a8', data: { progress: 20, description: '5 seconds left' }, }) // Finish task bridge.send('CondoWebAppUpdateProgressBar', { barId: '3f4714ab-30f9-4bd4-b91b-67e9c5b7f1a8', data: { progress: 100, description: 'done' }, })
progress-bar-example