minhnhut0602 / swift-sdk

Swift SDK for ConfigCat, a feature-flag and remote-config service with unlimited users and a free plan.

ConfigCat SDK for Swift

https://configcat.com

ConfigCat SDK for Swift provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Management Console even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

Getting started

1. Install the package

CocoaPods:

Add the following to your Podfile:

target '<YOUR TARGET>' do
pod 'ConfigCat'
end

Then, run the following command to install your dependencies:

pod install

Carthage:

Add the following to your Cartfile:

github "configcat/swift-sdk"

Then, run the carthage update command and then follow the Carthage integration steps to link the framework with your project.

2. Go to Connect your application tab to get your API Key:

3. Import the ConfigCat module to your application

import ConfigCat

4. Create a ConfigCat client instance

let client = ConfigCatClient(apiKey: "#YOUR-API-KEY#")

5. Get your setting value

let isMyAwesomeFeatureEnabled = client.getValue(for: "isMyAwesomeFeatureEnabled", defaultValue: false)
if(isMyAwesomeFeatureEnabled) {
    doTheNewThing()
} else {
    doTheOldThing()
}

Or use the async APIs:

client.getValueAsync(for: "isMyAwesomeFeatureEnabled", defaultValue: false, completion: { isMyAwesomeFeatureEnabled in
        if(isMyAwesomeFeatureEnabled) {
            doTheNewThing()
        } else {
            doTheOldThing()
        }
    })

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to the getValue() function.

Read more about Targeting here.

let user = User(identifier: "#USER-IDENTIFIER#")
let isMyAwesomeFeatureEnabled = client.getValue(for: "isMyAwesomeFeatureEnabled", user: user, defaultValue: false)
if(isMyAwesomeFeatureEnabled) {
    doTheNewThing()
} else {
    doTheOldThing()
}

Sample/Demo app

Sample iOS app

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

Support

If you need help how to use this SDK feel free to to contact the ConfigCat Staff on https://configcat.com. We're happy to help.

Contributing

Contributions are welcome.

About ConfigCat

• Official ConfigCat SDK's for other platforms
• Documentation
• Blog