Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 5.54 KB

README.md

File metadata and controls

95 lines (72 loc) · 5.54 KB
Raw

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.

Twitter Follow

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 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. 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 to find all you need to submit a Pull Request (PR).

License

Licensed under the Apache License, Version 2.0. See: Apache License.

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 [email protected], or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.