This library defines the interfaces for communicating with Recovery UI components
PROTOCOLS
FactoryResetCountdown
Defined in fuchsia.recovery.ui/countdown.fidl
Protocol to watch for changes when a factory reset countdown is started or cancelled. An immediate factory reset does not start a countdown.
Watch
Hanging get that returns when a factory reset is scheduled or a scheduled factory reset is cancelled. Will return immediately on first call per connection and then on change after that.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
state |
FactoryResetCountdownState
|
ProgressRenderer
Defined in fuchsia.recovery.ui/progress.fidl
Protocol to receive progress updates to display a carnelian based progress bar UI.
Render
Called to send progress updates to the renderer.
The return value is used for flow control, and implementers should acknowledge receipt of each message in order to continue receiving future messages.
Request
| Name | Type |
|---|---|
status |
Status
|
percent_complete |
float32
|
Response
<EMPTY>
Render2
Called to send progress updates to the renderer.
This call optionally contains timing or speed information for the progress bar to move slowly to percent_complete
The return value is used for flow control, and implementers should acknowledge receipt of each message in order to continue receiving future messages.
Request
| Name | Type |
|---|---|
payload |
ProgressRendererRender2Request
|
Response
<EMPTY>
ENUMS
Status strict
Type: uint32
Defined in fuchsia.recovery.ui/progress.fidl
| Name | Value | Description |
|---|---|---|
ACTIVE |
1 |
|
PAUSED |
2 |
|
ERROR |
3 |
|
CANCELLED |
4 |
|
COMPLETE |
5 |
TABLES
FactoryResetCountdownState
Defined in fuchsia.recovery.ui/countdown.fidl
Information provided through the FactoryResetCountdown protocol on the current factory reset state.
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
scheduled_reset_time |
zx/time
|
The time of when factory reset is scheduled to be triggered when a countdown for factory reset is in progress with respect to the monotonic clock. This field is left unpopulated if no reset is scheduled. |
ProgressRendererRender2Request
Defined in fuchsia.recovery.ui/progress.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
status |
Status
|
|
2 |
percent_complete |
float32
|
Optional, only used with status ACTIVE No value or an invalid value sets the progress bar to 0% Values: [0.0 - 100.0] |
3 |
elapsed_time |
zx/duration
|
Time to take to move slowly to percent_complete Optional, only used with status ACTIVE No value indicates an instant jump to percent_complete |