Upgrading to 7.8.0 and above
Upgrading to 7.8.0 and above
The Helpshift SDK v7.8.0 is a major update and we have made some important changes. If you have questions or feedback, please Contact Us
Framework packaging for SDK
With version 7.8.0, Helpshift SDK is packaged as a dynamic framework rather than a static library. Please follow the steps mentioned here if you are migrating from an older version of Helpshift SDK.
Manual Integration
- Remove all Helpshift SDK related files from the project. These include -
- HelpshiftSupport.h
- HelpshiftCore.h
- HsUIResourceBundle.bundle
- HsLocalization.bundle
- HelpshiftConfig.plist
- HelpshiftConfigDark.plist
No changes are needed for custom theming plists and custom localization bundle when migrating. The old theming files and localization bundle will continue to work as expected.
In case you have made changes to HelpshiftConfig.plist or HelpshiftConfigDark.plist, please rename the files to HelpshiftCustomConfig.plist and HelpshiftCustomConfigDark.plist respectively.
- Remove
/usr/lib/swift
from runpath search paths in the build settings, if other SDKs in your app don’t need it - Remove
$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)
and$(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)
fromLibrary Search Paths
in the build settings, if other SDKs in your app don’t need it - Ensure
Always Embed Swift Standard Libraries
is set to YES in the build settings After doing these, please follow the steps here to integrate the framework version of the SDK.
Cocoapods Integration
After updating your podfile to use v7.8.0 of Helpshift SDK and running pod install
, perform the following steps -
- Remove
/usr/lib/swift
from runpath search paths in the build settings, if other SDKs in your app don’t need it - Remove
$(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)
and$(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)
fromLibrary Search Paths
in the build settings, if other SDKs in your app don’t need it - Ensure
Always Embed Swift Standard Libraries
is set to YES in the build settings
Code changes
Objective C App
- Replace any instances of #import
”HelpshiftSupport.h”
and#import ”HelpshiftCore.h”
with@import Helpshift
;
Swift App
- Remove all Helpshift related
#import
directives from your app’s Bridging header - Add the
import Helpshift
directive in Swift files using Helpshift APIs