https://github.com/splitio/android-client
Android SDK client for Split Software
https://github.com/splitio/android-client
ab-testing android experimentation feature-flags feature-toggles java
Last synced: 3 months ago
JSON representation
Android SDK client for Split Software
- Host: GitHub
- URL: https://github.com/splitio/android-client
- Owner: splitio
- License: other
- Created: 2017-11-03T19:46:45.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T13:20:21.000Z (about 1 year ago)
- Last Synced: 2024-12-21T14:38:25.744Z (about 1 year ago)
- Topics: ab-testing, android, experimentation, feature-flags, feature-toggles, java
- Language: Java
- Homepage: https://split.io
- Size: 18.2 MB
- Stars: 17
- Watchers: 19
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Split SDK for Android
## Overview
This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.
[](https://twitter.com/intent/follow?screen_name=splitsoftware)
## Compatibility
This SDK is compatible with Android SDK versions 15 and later (4.0.3 Ice Cream Sandwich).
## Getting started
Below is a simple example that describes the instantiation and most basic usage of our SDK:
```
String sdkKey = "YOUR_SDK_KEY";
SplitClientConfig config = SplitClientConfig.builder()
.build();
// User Key
String matchingKey = "CUSTOMER_ID";
Key key = new Key(matchingKey);
SplitClient splitClient = null;
try {
// Create a Split factory
SplitFactory splitFactory = SplitFactoryBuilder.build(sdkKey, key, config, getApplicationContext());
// Get Split Client instance
splitClient = splitFactory.client();
} catch (Exception e) {
e.printStackTrace();
}
final SplitClient client = splitClient;
splitClient.on(SplitEvent.SDK_READY, new SplitEventTask(){
public void onPostExecution(SplitClient client) {
Log.i("TAG", "Do some NO UI work");
String treatment = client.getTreatment("FEATURE_FLAG_NAME");
if (treatment.equals("on")) {
Log.i("TAG", "I'm ON ");
} else if (treatment.equals("off")) {
Log.i("TAG", "I'm OFF");
} else {
Log.i("TAG", "CONTROL was returned, there was an error");
}
}
public void onPostExecutionView(SplitClient client) {
Log.i("TAG", "Do some UI work");
}
});
```
Please refer to [our official docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK) to learn about all the functionality provided by our SDK and the configuration options available for tailoring it to your current application setup.
## Submitting issues
The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/android-client/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
## Contributing
Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
## License
Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
## About Split
Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.
To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.
Split has built and maintains SDKs for:
* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
* Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
* Javascript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)
For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
**Learn more about Split:**
Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.