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

Tidy up "Sending data to Plugins" page

Browse Source 
Summary:
* Made the code snippets uniform across languages.
* Renamed to "Providing data to plugins" because sending hints at sending across the desktop-client connection which is misleading.

Reviewed By: danielbuechele

Differential Revision: D15198081

fbshipit-source-id: e2c318cdc6055c191f47e846b518c26dd21e4a68
This commit is contained in:
John Knox
2019-05-03 07:07:40 -07:00
committed by Facebook Github Bot
parent c55bebd1be
commit f72e4b5122
2 changed files with 8 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/extending/send-data.md
View File

@@ -1,21 +1,19 @@
---
id: send-data
title: Sending Data to Plugins
title: Providing data to plugins
---
It is often useful to get an instance of a Flipper plugin to send data to it. Flipper makes this simple with built-in support.
Plugins should be treated as singleton instances as there can only be one `FlipperClient` and each `FlipperClient` can only have one instance of a certain plugin. The Flipper API makes this simple by offering a way to get the current client and query it for plugins.
Plugins are identified by the string that their identifier method returns, in this example, "MyFlipperPlugin":
Plugins are identified by the string that their identifier method returns, in this example, "MyFlipperPlugin". Note that null checks may be required as plugins may not be initialized, for example in production builds.
<!--DOCUSAURUS_CODE_TABS-->
<!--Android-->
```java
final FlipperClient client = AndroidFlipperClient.getInstance(context);
// Client may be null if AndroidFlipperClient.createInstance() was never called
// which is the case in production builds.
if (client != null) {
final MyFlipperPlugin plugin = client.getPluginByClass(MyFlipperPlugin.class);
plugin.sendData(myData);
@@ -29,13 +27,11 @@ MyFlipperPlugin *myPlugin = [client pluginWithIdentifier:@"MyFlipperPlugin"];
```
<!--C++-->
```c++
auto &client = FlipperClient::instance();
// "MyFlipperPlugin" is the return value of MyFlipperPlugin::identifier()
auto& client = FlipperClient::instance();
auto myPlugin = client.getPlugin<MyFlipperPlugin>("MyFlipperPlugin");
myPlugin->sendData(myData);
```
if (myPlugin) {
myPlugin->sendData(myData);
}
```
<!--END_DOCUSAURUS_CODE_TABS-->

4
website/i18n/en.json
View File

@@ -38,7 +38,7 @@
"title": "JavaScript Plugin Definition"
},
"extending/layout-inspector": {
"title": "Extending the Layout Inspector"
"title": "Extending Layout Inspector"
},
"extending/new-clients": {
"title": "Implementing a Flipper Client"
@@ -47,7 +47,7 @@
"title": "Searching and Filtering"
},
"extending/send-data": {
"title": "Sending Data to Plugins"
"title": "Providing data to plugins"
},
"extending/styling-components": {
"title": "Styling Components"