jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Expose current connection status to Sandy plugins

Browse Source 
Summary:
Introduced `isConnected` flag on device and plugin client to reflect whether a connection is still available for the plugins, or that they have been disconnected.

Potentially we could expose the (readonly) `connected` state atom for this as well, or an `onDisconnect` event for device pugins, to create a responsive UI, but there might be no need for that, in which case this suffices.

Reviewed By: nikoant

Differential Revision: D26249346

fbshipit-source-id: b8486713fdf2fcd520488ce54f771bd038fd13f8
This commit is contained in:
Michel Weststrate
2021-02-09 04:12:09 -08:00
committed by Facebook GitHub Bot
parent 7e1bf0f58b
commit bb529411b5
6 changed files with 62 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/extending/flipper-plugin.mdx
View File

@@ -51,6 +51,13 @@ The name of the application, for example 'Facebook', 'Instagram' or 'Slack'.
A string that uniquely identifies the current application, is based on a combination of the application name and device serial on which the application is running.
#### `isConnected`
Returns whether there is currently an active connection. This is true if:
1. The device is still connected
2. The client is still connected
3. The plugin is currently selected by the user _or_ the plugin is running in the background.
### Events listeners
#### `onMessage`
@@ -182,6 +189,9 @@ Usage: `client.send(method: string, params: object): Promise<object>`
If the plugin is connected, `send` can be used to invoke a [method](create-plugin#[background-plugins#using-flipperconnection) on the client implementation of the plugin.
Note that if `client.isConnected` returns `false`, calling `client.send` will throw an exception. This is the case if for example the connection with the device or application was lost.
Generally one should guard `client.send` calls with a check to `client.isConnected`.
Example:
```typescript
@@ -362,6 +372,10 @@ A `string` that describes whether the device is a physical device or an emulator
This `boolean` flag is `true` if the current device is coming from an import Flipper snapshot, and not an actually connected device.
#### isConnected
This `boolean` flag is `true` if the connection to the device is still alive.
### Events
#### `onLogEntry`