| <link rel="stylesheet" href="../style.css" /> |
| |
| [TOC] |
| # fuchsia.bluetooth.fastpair |
| |
| <div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 10</span></div> |
| |
| |
| ## **PROTOCOLS** |
| |
| ## Provider {#Provider} |
| *Defined in [fuchsia.bluetooth.fastpair/provider.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth.fastpair/provider.fidl;l=29)* |
| <p>Protocol to enable the Bluetooth Fast Pair Provider service on the system.</p> |
| |
| |
| ### Enable {#Provider.Enable} |
| |
| <p>Request to enable the Fast Pair Provider service.</p> |
| <p>Only one client can register to enable the Fast Pair service. An Error will be returned |
| for subsequent requests.</p> |
| <p>The lifetime of the service is tied to the provided <code>watcher</code>. To disable Fast Pair |
| functionality, close the <code>watcher</code>.</p> |
| <ul> |
| <li>request <code>watcher</code> The client end of the ProviderWatcher which determines the lifetime of |
| the Fast Pair service.</li> |
| </ul> |
| <ul> |
| <li>response An empty response will be sent when the server has processed the |
| request.</li> |
| </ul> |
| <ul> |
| <li>error Returns <code>ALREADY_BOUND</code> if a subsequent request is made to enable |
| the service.</li> |
| </ul> |
| |
| |
| |
| #### Request {#Provider.Enable_Request} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>watcher</code></td> |
| <td> |
| <code><a class='link' href='#ProviderWatcher'>ProviderWatcher</a></code> |
| </td> |
| </tr> |
| </table> |
| |
| |
| #### Response {#Provider.Enable_Response} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>result</code></td> |
| <td> |
| <code><a class='link' href='#Provider_Enable_Result'>Provider_Enable_Result</a></code> |
| </td> |
| </tr> |
| </table> |
| |
| ## ProviderWatcher {#ProviderWatcher} |
| *Defined in [fuchsia.bluetooth.fastpair/provider.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth.fastpair/provider.fidl;l=17)* |
| <p>Represents an active Fast Pair Provider service. The lifetime of the service is tied to this |
| protocol.</p> |
| <p>Closing the protocol disables the service.</p> |
| <p>The system may close the protocol to communicate that the service was terminated |
| for internal reasons.</p> |
| |
| |
| ### OnPairingComplete {#ProviderWatcher.OnPairingComplete} |
| |
| <p>Called if the Fast Pair pairing procedure for a peer is successfully complete.</p> |
| <ul> |
| <li>request <code>id</code> The unique ID associated with the connected Fast Pair Seeker peer.</li> |
| </ul> |
| <ul> |
| <li>response Each <code>OnPairingComplete</code> request should be acknowledged.</li> |
| </ul> |
| |
| |
| |
| #### Request {#ProviderWatcher.OnPairingComplete_Request} |
| |
| <table> |
| <tr><th>Name</th><th>Type</th></tr> |
| <tr> |
| <td><code>id</code></td> |
| <td> |
| <code><a class='link' href='../fuchsia.bluetooth/'>fuchsia.bluetooth</a>/<a class='link' href='../fuchsia.bluetooth/#PeerId'>PeerId</a></code> |
| </td> |
| </tr> |
| </table> |
| |
| |
| #### Response {#ProviderWatcher.OnPairingComplete_Response} |
| |
| <EMPTY> |
| |
| |
| ## **STRUCTS** |
| |
| ### Provider_Enable_Response {#Provider_Enable_Response data-text="Provider_Enable_Response"} |
| *Defined in [fuchsia.bluetooth.fastpair/provider.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth.fastpair/provider.fidl;l=46)* |
| |
| <EMPTY> |
| |
| |
| |
| |
| ## **UNIONS** |
| |
| ### Provider_Enable_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Provider_Enable_Result data-text="Provider_Enable_Result"} |
| *Defined in [fuchsia.bluetooth.fastpair/provider.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth.fastpair/provider.fidl;l=46)* |
| <table> |
| <tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr> |
| <tr id="Provider_Enable_Result.response"> |
| <td><h3 id="Provider_Enable_Result.response" class="add-link hide-from-toc">1</h3></td> |
| <td><code>response</code></td> |
| <td> |
| <code><a class='link' href='#Provider_Enable_Response'>Provider_Enable_Response</a></code> |
| </td> |
| <td></td> |
| </tr> |
| <tr id="Provider_Enable_Result.err"> |
| <td><h3 id="Provider_Enable_Result.err" class="add-link hide-from-toc">2</h3></td> |
| <td><code>err</code></td> |
| <td> |
| <code><a class='link' href='../zx/'>zx</a>/<a class='link' href='../zx/#status'>status</a></code> |
| </td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| |