startUpdateFlow()
Starts the flow to update an installed app to its latest released version. If the update requires new permissions, a consent modal opens. Otherwise, a loader modal opens and the app version updates.
Important: This method is only available in the editor.
Method declaration
Copy
Parameters
| Name | Type | Description |
|---|---|---|
args | UpdateFlowRequest | Configuration options for updating the app. |
UpdateFlowRequest
| Name | Type | Description |
|---|---|---|
appId | string | Required. The ID of the app to update. |
Returns
Copy
A promise that resolves to an UpdateFlowResponse indicating the result of the update attempt.
UpdateFlowResponse
| Name | Type | Description |
|---|---|---|
status | string | Status indicating that the update completed or explaining why it didn't. Possible values:
|
installedApps | InstalledApp[] | Array of updated apps. Includes the target app and any apps that were also installed or updated because they're dependencies for it. The response includes this field only if status is SUCCESS. |
InstalledApp
| Name | Type | Description |
|---|---|---|
appId | string | The ID of the updated app. |
version | string | The new version of the updated app. |
Examples
Update an app
Copy
Errors
This method may return the following error codes:
NOT_INSTALLED: The app isn't installed. Apps must be installed before they can be updated.ALREADY_UP_TO_DATE: The app is already up to date.
Did this help?