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

Show communcating with devices page

Browse Source 
Summary:
This page got lost in the reorganisation. Adding it back.
There's still work to be done on the content and organisation of these docs.

Reviewed By: passy

Differential Revision: D15184349

fbshipit-source-id: 76256ba53189579bec363903dc4068a421cafc98
This commit is contained in:
John Knox
2019-05-02 12:34:15 -07:00
committed by Facebook Github Bot
parent d022cd0e42
commit a276af9c1f
2 changed files with 7 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/communicating.md → docs/extending/communicating.md
View File

@@ -24,20 +24,16 @@ There are three main ways your desktop plugin can communicate with connected dev
With remote method calls your plugin can call a method on the attached client. This is useful for querying information from the client that your plugin wants to display. The first parameter is the name of the client API and the second is the specific method on that API. Optionally a JSON object can be passed as an argument to the client. With remote method calls your plugin can call a method on the attached client. This is useful for querying information from the client that your plugin wants to display. The first parameter is the name of the client API and the second is the specific method on that API. Optionally a JSON object can be passed as an argument to the client.
```javascript ```javascript
this.client.call('methodName', DATA).then(res => { this.client.call('methodName', data).then(res => {
// res contains client response // res contains client response
}); });
``` ```
This function returns a promise so that you can await a potential response from the client. If you are calling a method on the client but don't expect a response then you should instead opt for using the `send()` function. This function returns a promise so that you can await a potential response from the client. This also gives you the opportunity to handle or report errors encountered by the client using `Promise.catch`.
```javascript
this.client.send('methodName', DATA);
```
## Subscriptions ## Subscriptions
A client is not only able to respond to method calls but also push data directly to the Flipper desktop app. With the subscribe API your plugin can subscribe to there pushes from the client. Pass the name of the method and the API it is part of as well as a callback function to start a subscription. Any time the client sends a push matching this method the callback will be called with any attached data as a javascript object. A client is not only able to respond to method calls but also push data directly to the Flipper desktop app. With the subscribe API your plugin can subscribe to data pushed from the client. Pass the name of the method and the API it is part of as well as a callback function to start a subscription. Any time the client sends a push matching this method the callback will be called with any attached data as a javascript object.
```javascript ```javascript
this.client.subscribe('methodName', data => { this.client.subscribe('methodName', data => {

8
website/i18n/en.json
View File

@@ -5,10 +5,6 @@
"previous": "Previous", "previous": "Previous",
"tagline": "Extensible mobile app debugging", "tagline": "Extensible mobile app debugging",
"docs": { "docs": {
"communicating": {
"title": "Device Communication",
"sidebar_label": "Device Communication"
},
"custom-ports": { "custom-ports": {
"title": "Running Flipper with different ports", "title": "Running Flipper with different ports",
"sidebar_label": "Using different ports" "sidebar_label": "Using different ports"
@@ -16,6 +12,10 @@
"extending/arch": { "extending/arch": {
"title": "Architecture" "title": "Architecture"
}, },
"extending/communicating": {
"title": "Device Communication",
"sidebar_label": "Device Communication"
},
"extending/create-plugin": { "extending/create-plugin": {
"title": "Mobile Setup" "title": "Mobile Setup"
}, },