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

Update send-data Flipper references

Browse Source 
Summary: Sonar -> Flipper

Reviewed By: danielbuechele

Differential Revision: D10114910

fbshipit-source-id: 28f5d6ac7a71ae645872adda820feea6adb21f73
This commit is contained in:
Pascal Hartig
2018-10-01 02:26:28 -07:00
committed by Facebook Github Bot
parent 3e971775c3
commit 184d952a61
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/send-data.md
View File

@@ -6,18 +6,18 @@ sidebar_label: Send Data
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 `SonarClient` and each `SonarClient` 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 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, "MySonarPlugin":
Plugins are identified by the string that their identifier method returns, in this example, "MyFlipperPlugin":
### Android
```java
final SonarClient client = AndroidFlipperClient.getInstance(context);
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 MySonarPlugin plugin = client.getPlugin("MySonarPlugin");
final MyFlipperPlugin plugin = client.getPlugin("MyFlipperPlugin");
plugin.sendData(myData);
}
```
@@ -33,16 +33,16 @@ MyFlipperPlugin *myPlugin = [client pluginWithIdentifier:@"MyFlipperPlugin"];
### C++
```c++
auto &client = SonarClient::instance();
auto &client = FlipperClient::instance();
// "MySonarPlugin is the return value of MySonarPlugin::identifier()
auto aPlugin = client.getPlugin("MySonarPlugin");
// "MyFlipperPlugin is the return value of MyFlipperPlugin::identifier()
auto aPlugin = client.getPlugin("MyFlipperPlugin");
// aPlugin is a std::shared_ptr<SonarPlugin>. Downcast to expected type.
auto myPlugin = std::static_pointer_cast<MySonarPlugin>(aPlugin);
// aPlugin is a std::shared_ptr<FlipperPlugin>. Downcast to expected type.
auto myPlugin = std::static_pointer_cast<MyFlipperPlugin>(aPlugin);
// Alternatively, use the templated version
myPlugin = client.getPlugin<MySonarPlugin>("MySonarPlugin");
myPlugin = client.getPlugin<MyFlipperPlugin>("MyFlipperPlugin");
myPlugin->sendData(myData);
```