blob: 6300e7a2d5aae140cc245942d94b37609fa4fd3c [file] [log] [blame] [view]
<link rel="stylesheet" href="../style.css" />
[TOC]
# fuchsia.ui.activity.control
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>
## **PROTOCOLS**
## Control {#Control}
*Defined in [fuchsia.ui.activity.control/control.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.ui.activity.control/control.fidl;l=21)*
<p>The Control protocol can be used to override the activity state of the
Activity Service (fuchsia.ui.activity).</p>
<p>State provided through this interface takes precedence over state which
is determined based on activity sent through the Tracker API.</p>
<p>Once a state has been assigned through this protocol, the Activity
Service will no longer determine state based on input to the
fuchsia.ui.activity.Tracker protocol, and instead will only report state
transitions occuring through the Control protocol.</p>
### SetState {#Control.SetState}
<p>Sets the Activity Service's state to <code>state</code>.
All listeners registered through the Provider protocol will immediately
be notified of the new state.</p>
<p>Typically, state transitions should occur minutes apart (e.g.
transition from ACTIVE to IDLE after 15 minutes of inactivity).</p>
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Deprecated: 9</span></div>
#### Request {#Control.SetState_Request}
<table>
<tr><th>Name</th><th>Type</th></tr>
<tr>
<td><code>state</code></td>
<td>
<code><a class='link' href='../fuchsia.ui.activity/'>fuchsia.ui.activity</a>/<a class='link' href='../fuchsia.ui.activity/#State'>State</a></code>
</td>
</tr>
</table>