Swiftpack.co - Package - configcat/swift-sdk

ConfigCat SDK for Swift

ConfigCat SDK for Swift provides easy integration between ConfigCat service and applications using Swift.

ConfigCat is a feature flag, feature toggle, and configuration management service. That lets you launch new features and change your software configuration remotely without actually (re)deploying code. ConfigCat even helps you do controlled roll-outs like canary releases and blue-green deployments. https://configcat.com

Build Status Coverage Status CocoaPods Carthage compatible Supported Platforms License

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. Log in to ConfigCat Management Console and go to your Project to get your API Key

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

Github

link
Stars: 3
Help us keep the lights on

Dependencies

Used By

Total: 0

Releases

2.1.2 - Nov 23, 2018

2.1.1 - Oct 16, 2018

2.1.0 - Oct 14, 2018

2.0.0 - Oct 7, 2018

1.0.3 - May 7, 2018