Skip to content

KalvadTech/Custompulse-appclip-sdk

Repository files navigation

CustomerPulse

Displays CustomerPulse surveys in Swift.
CustomerPulse is a module written in Swift allowing developer to easily integrate CustomerPulse surveys in their applications.

Latest version : 1.3.0
https://github.com/KalvadTech/hm-ios-sdk/releases/tag/1.3.0

Installation

Cocoapods

You can add CustomerPulse to your project using Cocoapods.

If Cocoapods is not added to your project, run pod init in the root directory of your Xcode project.

Simply add pod 'CustomerPulse' to your Podfile. Then run pod install in your terminal.

If you are not familiar with Cocoapods, this will create a [project].xcworkspace that you will have to use from now on.

To import the SDK to your project

import CustomerPulse

Manually

If you do not want to add CustomerPulse using Cocoapods, you can add CustomerPulse.xcframework to your project. You can find the framework in the build folder of the SDK.

To import the SDK to your project

import CustomerPulse

Usage

First, initialise the SDK using your token or link.

let csSDK: CustomerPulse = CustomerPulse.init("APP_ID", "TOKEN_OR_LINK")

Finally, simply display the survey for your users.

self.csSDK.showSurvey(on: self, isDismissible: true, dimissAfter: 1000, withOptions: ["lang": "en"])

Parameters

Name Type Description Default
on ViewController The view controller where the survey will pop up. N/A
isDismissible Bool Defines whether the survey is dismissible by the user. true
dimissAfter Int The value in milliseconds after which the questionnaire will close automatically after having been successfully completed. 1000
options [String: Any] Dictionary to specify optional parameters to load. (eg. lang='ar/en') [:]

Delegates

To be notified on certain actions, you have to subscribe to delegates. (If you want more information, check the example project)

func csUserCompletedSurvey() -> void

Automatically called whenever the user has successfully completed the survey

Getting Help

  • Have a bug to report? Open a GitHub issue. If possible, include the version of the build, a full log, and a project that shows the issue.
  • Have a feature request? Open a GitHub issue. Tell us what the feature should do and why you want the feature.

License

CustomerPulse is released under the MIT license. See LICENSE for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors