f72e4b5122
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
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
---
|
|
id: send-data
|
|
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". 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);
|
|
if (client != null) {
|
|
final MyFlipperPlugin plugin = client.getPluginByClass(MyFlipperPlugin.class);
|
|
plugin.sendData(myData);
|
|
}
|
|
```
|
|
<!--iOS-->
|
|
```objective-c
|
|
FlipperClient *client = [FlipperClient sharedClient];
|
|
MyFlipperPlugin *myPlugin = [client pluginWithIdentifier:@"MyFlipperPlugin"];
|
|
[myPlugin sendData:myData];
|
|
```
|
|
<!--C++-->
|
|
```c++
|
|
auto& client = FlipperClient::instance();
|
|
auto myPlugin = client.getPlugin<MyFlipperPlugin>("MyFlipperPlugin");
|
|
if (myPlugin) {
|
|
myPlugin->sendData(myData);
|
|
}
|
|
```
|
|
<!--END_DOCUSAURUS_CODE_TABS-->
|
|
|
|
|
|
Here, `sendData` is an example of a method that might be implemented by the Flipper plugin.
|