> For the complete documentation index, see [llms.txt](https://assetstore.essentialkit.voxelbusters.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://assetstore.essentialkit.voxelbusters.com/features/app-updater/playmaker/use-cases/use-case-3-prompt-update.md).

# Prompt Update (Manual Trigger)

## Goal

Prompt the user to update from a settings/help screen.

## Actions Required

| Action                            | Purpose                                       |
| --------------------------------- | --------------------------------------------- |
| AppUpdaterPromptUpdate            | Show native update prompt/flow                |
| AppUpdaterGetPromptUpdateError    | Read cached error after failure (optional)    |
| AppUpdaterGetPromptUpdateProgress | Read cached progress (Android only, optional) |

## Variables Needed

* progress (Float) (Android only, optional)

## Implementation Steps

### 1. UserPressedUpdateButton (Entry State)

From your Settings screen, when user presses “Check for Updates” / “Update App”:

* Go to PromptUpdate

### 2. PromptUpdate

**Action:** AppUpdaterPromptUpdate

* **Inputs:**
  * isForceUpdate: false
  * promptTitle / promptMessage: optional
* **Events:**
  * successEvent → Done
  * failureEvent → (Optional) ReadPromptError
  * progressUpdateEvent → (Optional) UpdateProgressUI (Android only)

### 3. (Optional) UpdateProgressUI

**Action:** AppUpdaterGetPromptUpdateProgress

* **Outputs:**
  * progress → progress

### 4. (Optional) ReadPromptError

**Action:** AppUpdaterGetPromptUpdateError

* **Outputs:** errorCode, errorDescription

## Common Issues

* **App backgrounding**: App may go to background during the update flow
* **Platform support**: PromptUpdate behavior differs between iOS/Android

## Platform Differences

* **iOS**: Typically opens App Store / update prompt UI
* **Android**: Uses Play Core update flow (progressUpdateEvent supported)

## Use When

* User-initiated “Update App” action
* Support/help flows directing users to update


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://assetstore.essentialkit.voxelbusters.com/features/app-updater/playmaker/use-cases/use-case-3-prompt-update.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.