Follow these steps to add Singular to your iOS project:

1. Install RudderSingular (available through CocoaPods) by adding the following line to your Podfile:

   pod 'RudderSingular', '~ 1.0.0'

2. After adding the dependencies followed by pod install command, add the imports to your AppDelegate file depending on your preferred platform:

   Swift

   import RudderSingular

   Obj-C

   @import RudderSingular;

3. In your AppDelegate file update the didFinishLaunchingWithOptions method:

   Important:

   • Setting the manualSkanConversionManagement = true will require you to manually update your own Conversion Values. This will NOT allow for Singular's SKAN Model to update the CV values on your behalf. Set this to "false" to enable "managed" mode.
   • Setting the waitForTrackingAuthorizationWithTimeoutInterval should only be used if your app uses the iOS App Tracking Transparency(ATT) Prompt. If you are displaying ATT, then this should be set to a value of 300.

   Swift

   let config: RSConfig = RSConfig(writeKey: WRITE_KEY)
               .dataPlaneURL(DATA_PLANE_URL)
   
   RSClient.sharedInstance().configure(with: config)
   let rudderSingularConfig = RudderSingularConfig()
               .skAdNetworkEnabled(true)
               .manualSkanConversionManagement(true)
               .conversionValueUpdatedCallback({ value in
                   print("Your SKAN handler \(value)")
               })
               .waitForTrackingAuthorizationWithTimeoutInterval(300)
   RSClient.sharedInstance().addDestination(RudderSingularDestination(rudderSingularConfig: rudderSingularConfig))
   

   Obj-C

   RSConfig *config = [[RSConfig alloc] initWithWriteKey:WRITE_KEY];
   [config dataPlaneURL:DATA_PLANE_URL];
   
   [[RSClient sharedInstance] configureWith:config];
   RudderSingularConfig *rudderSingularConfig = [[RudderSingularConfig alloc] init];
   [rudderSingularConfig skAdNetworkEnabled:YES];
   [rudderSingularConfig manualSkanConversionManagement:YES];
   [rudderSingularConfig conversionValueUpdatedCallback:^(NSInteger value) {
       printf("Your SKAN handler %ld", value);
   }];
   [rudderSingularConfig waitForTrackingAuthorizationWithTimeoutInterval:300];
   [[RSClient sharedInstance] addDestination:[[RudderSingularDestination alloc] initWithRudderSingularConfig:rudderSingularConfig]];
   

To add Singular to your Android app, follow these steps:

1. Open your app/build.gradle (Module: app) file, and add the following under the dependencies section :

   groovy

   implementation 'com.rudderstack.android.sdk:core:[1.0,2.0)'
   implementation 'com.rudderstack.android.integration:singular:1.0.0'
   implementation 'com.google.code.gson:gson:2.8.6'
   

2. Add the Singular Maven plugin to your build script. To do this, add the following snippet into the Gradle Scripts section of your root build.gradle:

   groovy

   buildscript {
       repositories {
           google()
           mavenCentral()
           maven {
             url 'https://maven.singular.net/'
           }
       }
       dependencies {
           classpath 'com.android.tools.build:gradle:7.1.2'
           classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.10'
       }
   }
   allprojects {
       repositories {
           google()
           mavenCentral()
           maven {
             url 'https://maven.singular.net/'
           }
       }
   }
   

3. Add the following permissions(if not present already) to your AndroidManifest.xml:

   <uses-permission android:name="android.permission.INTERNET"></uses-permission>
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>

4. Finally, initialize the RudderStack SDK in your Application class’ onCreate() method:

   // initialize Rudder SDK
   val rudderClient =
       RudderClient.getInstance(
           this,
           WRITE_KEY,
           RudderConfig.Builder()
               .withDataPlaneUrl(DATA_PLANE_URL)
               .withFactory(SingularIntegrationFactory.FACTORY)
               .build()
       )
   

To add Singular to your React Native app, follow these steps:

1. Add the RudderStack-Singular module to your app by running the following command:

   bash

   npm install @rudderstack/rudder-integration-singular-react-native
   // OR //
   yarn add @rudderstack/rudder-integration-singular-react-native

2. Open your project-level android/build.gradle file and add the following snippet:

   groovy

   repositories {
     maven {
       url "https://maven.singular.net/"
     }
   }
   

3. Import the above module and add it to your SDK initialization:

   typescript

   import rudderClient from "@rudderstack/rudder-sdk-react-native"
   import singular from "@rudderstack/rudder-integration-singular-react-native"
   const config = {
   	dataPlaneUrl: <data_plane_url>,
   	trackAppLifecycleEvents: true,
   	withFactories: [singular],
   }
   rudderClient.setup(<write_key>, config)

To add Singular to your Cordova app, follow these steps:

1. Navigate to the root folder of your application and run the following command:

   bash

   cordova plugin add rudder-integration-singular-cordova
   

2. Add the following code in the onDeviceReady() function of your app’s home page to initialize the SDK:

   javascript

   RudderClient.initialize(<write_key>, {
     dataPlaneUrl: <data_plane_url>,
     factories: [RudderSingularFactory]
   })

   Important: Make sure to use the `await` keyword with the `initialize` call.

RudderClient.getInstance()?.identify("1hKOmRA4el9Zt1WSfVJIVo4GRlm")

RudderClient.getInstance()
    ?.track(
        "Product Reviewed",
        RudderProperty()
            .putValue("product_id", "345676543")
            .putValue("review_id", "123454387")
    )

RudderClient.getInstance()
    ?.track(
        "Order Completed",
        RudderProperty().putValue("revenue", 1251).putValue("currency", "INR")
    )

RudderClient.getInstance()
    ?.screen(
        "Home",
        RudderProperty().putValue("category", "launcher")
    )

RudderClient.getInstance()?.reset();