# Swift UI App

{% hint style="info" %}
Latest Version: [1.2.1](https://github.com/surveysparrow/surveysparrow-ios-sdk/releases/tag/1.2.1)
{% endhint %}

Below are the various processes involved in setting up SpotChecks in IOS. Kindly refer example applications [here](https://github.com/surveysparrow/surveysparrow-ios-sdk/tree/master/SwiftUI-ExampleApp)

### Installation

* Open XCode and click on "**File**" menu
* Click on **"Add Package Dependency"**
* Enter the package URL -  <https://github.com/surveysparrow/surveysparrow-ios-sdk.git>
* Select the version of SDK and Add to App Targets.
* Then, click on **Add Package** to add the SurveySparrowSdk package to your IOS project.

The SurveySparrowSdk package can also be added by navigating to your target's General panel -> In the **“Frameworks, Libraries, and Embedded Content”** section, click on the **+ button** -> select "**Add Other "**-> choose **"Add Package Dependency"** -> Enter the above package URL -> Click on **Add Package.**

***

Additionally to use the camera accessibility, add these lines in the info.plist of the app.

```swift
<key>NSCameraUsageDescription</key>
<string>REASON</string> 
```

Also for voice transcription support, add these lines in the info.plist of the app

```swift
<key>NSMicrophoneUsageDescription</key>
<string>REASON</string>
        
<key>NSSpeechRecognitionUsageDescription</key>
<string>REASON</string>
```

### Initialization

Import the SurveySparrowSdk and initialize a variable named spotCheck.

```swift
import SurveySparrowSdk
```

**Anonymous users**

If you wish not to keep track of users' data, you can follow the below syntax for initialization.

```swift

var spotCheck = Spotcheck (
 domainName: "<your_domain>",
 targetToken: "<target_token>",
 userDetails: [:],
 variables: [:],
 customProperties: [:],
 sparrowLang: "ta" // Eg: ta, en, 
)
```

**Known Users**

If you wish to keep track of users' data and perform conditional Survey triggers, you can follow the below syntax for initialization.

```swift
var spotCheck = Spotcheck (
 domainName: "<your_domain>",
 targetToken: "<target_token>",
 userDetails: [
       email: 'example@email.com',
       firstName: '<your-first-name>',
       lastName: '<your-last-name>',
       mobile: '<user_mobile>',
       uuid: '<uuid_value>' // Optional
  ], 
 variables: [
       <api_identifier_of_variable>: '<variable_value>',
 ],
 customProperties: [
       <custom_property_name>:'<value>' 
 ],
 sparrowLang: "ta" // Eg: ta, en, 
)
```

Add the spotCheck in the Zstack of the topmost parent

```swift
ZStack {<your-app-code>, spotCheck}
```

### Screen Track

It provides the ability to keep track of screens the users are visiting and to enable the survey trigger on that screen.

#### Syntax:

```swift
.onAppear {
   spotCheck.TrackScreen(
      screen: "<your-screen-name>"  //eg. PaymentScreen
   )
}
```

#### Example:

If a survey needs to be triggered on the payment page, the name of the ScreenName should be specified in the TrackScreen function.

```swift
spotCheck.TrackScreen(
   screen: "PaymentScreen" 
) 
```

### Event Track

It provides the ability to keep track of events which when triggered, will enable the survey to be popped.&#x20;

#### Syntax:

```swift
spotCheck.TrackEvent(
   onScreen: "<your-screen-name>"  //eg. ScreenName, 
   event: [
      "<your-events-or-functions>":[:]  //eg. "onButtonPressed": [:] 
   ]
) 
```

#### Example:

If a survey needs to be triggered when the user completes a payment, then the TrackEvent function should be called with the respective ScreenName and optional custom properties.

```swift
spotCheck.TrackEvent(
    onScreen: "paymentScreen", 
    event: [ 
        "paymentComplete": [
            "email" : "naveen@surveysparrow.com",
            "paymentStatus" : true
        ] 
    ]
)
```

{% hint style="info" %}
Make sure to have the eventName configured in the Checks section of the configure panel
{% endhint %}

### Callbacks (Optional)

Callbacks are used to listen to events that are part of the SpotChecks. Below are the events:

* Survey Response - triggers when the user submits a response.
* Survey Loaded - triggers when the SpotChecks is loaded on the user's page.
* Survey Close - triggers when the SpotChecks is closed by the user.

#### Syntax:

<pre class="language-swift"><code class="lang-swift"><strong>// Step 1: Add callbacks to the SpotChecks Initialization
</strong>var spotCheck = Spotcheck(
    //...
    surveyDelegate: SsDelegate()
)
<strong>
</strong><strong>// Step 2: Listen to the SpotChecks events
</strong><strong>class SsDelegate: UIViewController, SsSurveyDelegate {
</strong>    func handleSurveyResponse(response: [String : AnyObject]) {}
    
    func handleSurveyLoaded(response: [String : AnyObject]) {}
    
    func handleSurveyValidation(response: [String : AnyObject]) {}
    
    func handleCloseButtonTap() {}
}
</code></pre>