# IOS Survey SDK

### Find Github Project Here : [QwarySurvey](https://github.com/manoj-qwary/QWarySurvey?utm_source=encharge\&utm_medium=email\&utm_campaign=Mobile+APP+SDK+Announcements\&utm_content=Introducing+Qwary%27s+new+mobile+app+SDK+for+in-app+feedback+%F0%9F%99%8C)

{% embed url="<https://vimeo.com/760581848?utm_campaign=Mobile+APP+SDK+Announcements&utm_content=Introducing+Qwary%27s+new+mobile+app+SDK+for+in-app+feedback+%F0%9F%99%8C&utm_medium=email&utm_source=encharge>" %}
Video Instructions for setting up IOS Survey App SDK
{% endembed %}

### Features

1. Full screen feedback
2. Embedded-screen feedback
3. Scheduled Surveys one-time or recurring feedbacks.

### Installation

#### Cocoapods

[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:

```bash
$ gem install cocoapods
```

To integrate QWarySurveySDK into your Xcode project using CocoaPods, specify it in your `Podfile`:

```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!

target '<Your Target Name>' do
pod 'QWarySurveySDK'
end
```

Then, run the following command:

```bash
$ pod install
```

### Usage

#### Full-screen feedback

Take feedback using our pre-build `QWSurveyViewController` and get the response after submission by implementing the `QWSurveyDelegate` protocol.

<figure><img src="https://i.imgur.com/MznJCGy.png" alt=""><figcaption></figcaption></figure>

**Import framework**

```swift
import QWarySurveySDK
```

**Create a `QWSurveyViewController`**

Create a `QWSurveyViewController` with `QWSurveyRequest` and `QWSurveyDelegate`

```swift
var urlQueryParams = [String:String]()
urlQueryParams["email"] = "jondoe2@acmeinc.com"
urlQueryParams["planId"] = "trial2"
let request = QWSurveyRequest(scheme: "https", host: "survey.qwary.com", path: "/form/S_wSzSPnasH9Wc_FT15X0J1BuEcPl5gIZ99rQiotQa8=", params: urlQueryParams)
let qwSurveyViewController = QWSurveyViewController(request: request, delegate: self)
present(qwSurveyViewController, animated: true, completion: nil)
```

#### Embed survey

Embed the feedback experience using the `QWSurveyView`.

<figure><img src="https://i.imgur.com/NK2laJU.png" alt=""><figcaption></figcaption></figure>

**Add QWSurveyView**

Add a `UIView` to storyboard and change the Class to `QWSurveyView` under *Identity Inspector* and also make sure that the Module is `QWarySurveySDK`.

Now connect the `QWSurveyView` as an `IBOutlet`

```swift
@IBOutlet weak var qwSurveyView: QWSurveyView!
```

Then call `loadSurvey(request: QWSurveyRequest, delegate: QWSurveyDelegate?)` on the `qwSurveyView` to load the survey

```swift
let request = QWSurveyRequest(scheme: "https", host: "survey.qwary.com", path: "/form/S_wSzSPnasH9Wc_FT15X0J1BuEcPl5gIZ99rQiotQa8=", params: [String:String]())
qwSurveyView.loadSurvey(request: request, delegate: self)
```

**Handle response**

Implement `QWSurveyDelegate` protocol to handle responses.

#### Schedule Surveys

Ask the user to take a feedback survey when they open your app or a screen after specified time. Local notifications are also scheduled for next prompt date/time if the survey has `repeatSurvey:true` in `QWScheduleConfigurations`.

Override viewDidAppear method and create a `QWSurvey` object with `QWSurveyRequest`, `QWSurveyDelegate` and `QWScheduleConfigurations`. Then call `scheduleSurvey` method on the `QWSurvey` object by passing the parent `ViewController` reference to schedule the survey.

```swift
override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
    let qwSurvey = QWSurvey(request: request, delegate: self, configurations: QWScheduleConfigurations.testConfigs)
    qwSurvey.scheduleSurvey(parent: self)
}
```

**Schedule Configurations**

| Property                       | Description                                                                                                                                                        |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `startDate: String`            | Survey is allowed to be shown to user at this date.                                                                                                                |
| `repeatSurvey: Bool`           | After survey completion, if user should be asked for same survey again. If this property is set `true` then make sure you set a value of `repeatInterval` as well. |
| `repeatInterval: TimeInterval` | Time interval for survey to be shown to user after last attempt. This property should always have a value when `repeatSurvey` is set `true`                        |

**Handle response**

Implement `QWSurveyDelegate` protocol to handle responses.

### License

QWarySurveySDK is licensed under the Apache License 2.0.

For more details visit <http://www.apache.org/licenses/LICENSE-2.0>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.qwary.com/product-guide/installation/mobile-app-sdk/ios-survey-sdk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.