Swift SDK Configuration Options Reference

The RudderStack Swift SDK provides various configuration options to customize its behavior according to your requirements. This guide covers all the available configuration options and their usage.

Configuration class

The Configuration class is used to initialize the SDK in your Apple platform application. It defines the required parameters and optional configuration settings to customize the SDK behavior.

SDK configuration options

Session configuration

The SessionConfiguration class provides the following parameters to customize session management:

Device ID collection

When you enable collectDeviceId, the SDK retrieves a unique device ID and includes it in the event payload under the device.id field in the event’s context object.

In the iOS, watchOS, and tvOS platforms, the SDK uses the device’s identifierForVendor field. In macOS, it derives the ID from the device’s MAC address.

If the SDK retrieves an empty or invalid value for the device ID, it will not include the device.id field in the event payload’s context.

Request compression

When you set gzipEnabled to true, all /batch requests sent by the SDK will have their payloads compressed using Gzip compression, thereby reducing the size of the network requests.

Sample SDK initialization

The following snippet demonstrates how to initialize the Swift SDK with the supported configuration options:

let analytics = Analytics(
    configuration: Configuration(
        // Required parameters
        writeKey: "YOUR_WRITE_KEY",
        dataPlaneUrl: "YOUR_DATA_PLANE_URL",
        
        // Optional parameters
        controlPlaneUrl: "https://api.rudderlabs.com",
        gzipEnabled: true,
        flushPolicies: [
            StartupFlushPolicy(),
            CountFlushPolicy(flushAt: 20),
            FrequencyFlushPolicy(flushIntervalInMillis: 30000)
        ], // Sets custom flush policies
        collectDeviceId: true,
        trackApplicationLifecycleEvents: true,
        sessionConfiguration: SessionConfiguration(
            automaticSessionTracking: true,
            sessionTimeoutInMillis: 300000 // 5 minutes
        )
    )
)

RSSConfigurationBuilder *builder = [[RSSConfigurationBuilder alloc]
// Required parameters
          initWithWriteKey:@"YOUR_WRITE_KEY"
					dataPlaneUrl:@"YOUR_DATA_PLANE_URL"];
					
// Optional parameters
[builder setControlPlaneUrl: @"https://api.rudderlabs.com"];
[builder setGzipEnabled: YES];
[builder setFlushPolicies: @[
        [RSSStartupFlushPolicy new],
        [[RSSCountFlushPolicy alloc] initWithFlushAt: 20],
        [[RSSFrequencyFlushPolicy alloc] initWithFlushIntervalInMillis: 30000]
]];
[builder setCollectDeviceId: YES];
[builder setTrackApplicationLifecycleEvents: YES];

// Prepare Session Configuration
RSSSessionConfigurationBuilder *sessionBuilder = [RSSSessionConfigurationBuilder new];
[sessionBuilder setAutomaticSessionTracking: YES];
[sessionBuilder setSessionTimeoutInMillis: @30000];
    
[builder setSessionConfiguration: [sessionBuilder build]];

RSSAnalytics *analytics = [[RSSAnalytics alloc] 
																			initWithConfiguration:[builder build]];

Questions? Contact us by email or on Slack