| <link rel="stylesheet" href="../style.css" /> |
| |
| [TOC] |
| # fuchsia.update.channelcontrol |
| |
| <div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div> |
| |
| |
| ## **PROTOCOLS** |
| |
| ## ChannelControl {#ChannelControl} |
| *Defined in [fuchsia.update.channelcontrol/channelcontrol.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.update.channelcontrol/channelcontrol.fidl;l=11)* |
| <p>Control the target update channel, this is the channel we will use on the next update check.</p> |
| |
| |
| ### GetCurrent {#ChannelControl.GetCurrent} |
| |
| <p>Retrieve the currently active update channel.</p> |
| <ul> |
| <li>response <code>channel</code> the currently active update channel.</li> |
| </ul> |
| |
| |
| |
| #### Request {#ChannelControl.GetCurrent_Request} |
| |
| <EMPTY> |
| |
| |
| #### Response {#ChannelControl.GetCurrent_Response} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>channel</code></td> |
| <td> |
| <code>string[128]</code> |
| </td> |
| </tr> |
| </table> |
| |
| ### GetTarget {#ChannelControl.GetTarget} |
| |
| <p>Get the current tentative target channel for updates. |
| This returns the channel that the update client is using to perform update |
| checks. It's always one of: |
| - the current channel |
| - the default channel |
| - a new target that's different, but hasn't been OTA'd from yet.</p> |
| <ul> |
| <li>response <code>channel</code> the current target channel.</li> |
| </ul> |
| |
| |
| |
| #### Request {#ChannelControl.GetTarget_Request} |
| |
| <EMPTY> |
| |
| |
| #### Response {#ChannelControl.GetTarget_Response} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>channel</code></td> |
| <td> |
| <code>string[128]</code> |
| </td> |
| </tr> |
| </table> |
| |
| ### GetTargetList {#ChannelControl.GetTargetList} |
| |
| <p>Get the list of well-known target channels that can be passed to SetTarget(). |
| There may be other, unlisted channels.</p> |
| |
| |
| |
| #### Request {#ChannelControl.GetTargetList_Request} |
| |
| <EMPTY> |
| |
| |
| #### Response {#ChannelControl.GetTargetList_Response} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>channels</code></td> |
| <td> |
| <code>vector<string>[100]</code> |
| </td> |
| </tr> |
| </table> |
| |
| ### SetTarget {#ChannelControl.SetTarget} |
| |
| <p>Set a new desired target channel. This tells the updater to attempt to |
| check for updates using a new channel. This is tentative, and won't be |
| persisted unless an update check on that channel is successful.</p> |
| <p>A response is generated when the new target channel has been verified as |
| valid.</p> |
| <ul> |
| <li>request <code>channel</code> the new target channel name (name used by the updater)</li> |
| </ul> |
| |
| |
| |
| #### Request {#ChannelControl.SetTarget_Request} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>channel</code></td> |
| <td> |
| <code>string[128]</code> |
| </td> |
| </tr> |
| </table> |
| |
| |
| #### Response {#ChannelControl.SetTarget_Response} |
| |
| <EMPTY> |
| |
| |
| |
| |
| |
| |
| |