HelpCrunch SDK

A perfect live chat, email automation and a super-intuitive help desk in one smart customer communication platform.

Contents

• Requirements
• Installation
  • CocoaPods
  • Carthage
  • Swift Package Manager
  • Manual installation
  • Update Info.plist
• Documentation
• License

Requirements

• iOS 13+
• Xcode 12.0+
• ObjC / Swift 4.0+

Installation

CocoaPods

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. It has over 43 thousand libraries and is used in over 3 million apps. CocoaPods can help you scale your projects elegantly.

CocoaPods is built with Ruby and is installable with the default Ruby available on OS X. We recommend you use the default ruby.

Using the default Ruby install can require you to use sudo when installing gems. Further installation instructions are in the guides.

$ sudo gem install cocoapods

There is also Mac app for CocoaPods. It only gets major releases ATM though.

Podfile

To integrate HelpCrunch into your Xcode project using CocoaPods, specify it in your Podfile (text file named Podfile in your Xcode project directory):

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

target 'ProjectTargetName' do
  pod 'HelpCrunchSDK', '~> 4.0'
end

Tip: CocoaPods provides a pod init command to create a Podfile with smart defaults. You should use it.

Now you can install the dependencies in your project:

$ pod install

Make sure to always open the Xcode workspace instead of the project file when building your project:

$ open App.xcworkspace

Now you can import your dependencies e.g.:

ObjC:

@import HelpCrunchSDK;

Swift:

import HelpCrunchSDK

Carthage

Carthage is another way to add frameworks to your Cocoa application.

Carthage builds your dependencies and provides you with binary frameworks, but you retain full control over your project structure and setup. Carthage does not automatically modify your project files or your build settings.

If you haven't installed it yet, please check quick-start guide

Cartfile

Create a Cartfile in the same directory where your .xcodeproj or .xcworkspace is.

Open Cartfile and add github "helpcrunch/helpcrunchsdk-ios" ~> 4.0

Run:

$ carthage update --platform ios --use-xcframeworks

Open General settings. Drag the built HelpcrunchSDK.xcframework binary from Carthage/Build/iOS into Embedded Binaries section. Don't forget to select Copy items if needed

Swift Package Manager

SPM is a modern way to add libs to your project. It's built-in Xcode, so you don't need to install additional tools. You can add HelpCrunchSDK as a Swift Package Repository in Xcode. You can do it by clicking on

File -> Swift Packages -> Add Package Dependency... 

or

Project -> YOUR_PROJECT_NAME -> Swift Packages -> +.

And add this url: https://github.com/helpcrunch/helpcrunchsdk-ios Then just follow the onscreen instructions.

Manual installation

You will be required to do several extra steps:

Download HelpcrunchSDK.xcframework and copy it into Embedded Binaries section. Don't forget to select Copy items if needed.

Update Info.plist

In order to send files and photos, you need to have NSCameraUsageDescription, NSPhotoLibraryAddUsageDescription and NSPhotoLibraryUsageDescription entries in your Info.plist.

These entries are required by Apple. User will be prompted for the Camera/Photo Library permissions with your provided text only when he tries to use the camera or open or save image to the Photo Library.

NSCameraUsageDescription - When user tries to use Camera

NSPhotoLibraryUsageDescription - When user tries to open Photo Library

NSPhotoLibraryAddUsageDescription - When user tries to save image to the Photo Library

Documentation

Documentation is available here Also you can check swift and objc app examples here

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details