The Smooch Help Kit library is an extension to the capabilities of the Smooch iOS SDK. This library adds self-help functionality, as well as an app-wide gesture to access help from anywhere in the app.
Check out the wiki for descriptions of the features.
Add pod SmoochHelpKit
to your Podfile, and run pod install
Note: SmoochHelpKit
registers Smooch
as a dependent pod, so if you are already using the Smooch
pod, you may replace it with this one.
- Follow the instructions for manual installation of the Smooch SDK.
- Download the latest zip file, and extract it.
- Copy the
SmoochHelpKit
directory into your project - Add the required libraries and frameworks to your project's
Link Binary With Libraries
build phase.
- SystemConfiguration.framework
- UIKit.framework
- Foundation.framework
- OpenGLES.framework
- QuartzCore.framework
- CoreText.framework
- Add the
-lxml2
flag to your app’sOther Linker Flags
build setting. - Add the line
$(SDKROOT)/usr/include/libxml2
to your app'sHeader Search Paths
build setting.
Sign up and get an app token at app.smooch.io. Then, in application:didFinishLaunchingWithOptions:
#import "SmoochHelpKit.h"
SHKSettings* settings = [SHKSettings settingsWithAppToken:@"YOUR_APP_TOKEN"];
[SmoochHelpKit initWithSettings:settings];
Note: SHKSettings
derives from SKTSettings
, and calling [SmoochHelpKit initWithSettings:]
will automatically call through to [Smooch initWithSettings:]
. There is no need to call +initWithSettings:
on both classes.
To show the UI:
[SmoochHelpKit show];
For Help Kit API documentation, see the SmoochHelpKit.h
and SHKSettings.h
header files.
For Smooch documentation, visit the docs
Copyright (c) 2015 Smooch Technologies Inc. All rights reserved. See here for license details.
This library makes use of, was inspired by, and distributes a number of other open-source components. Special thanks to the creators and maintainers of these libraries (in no particular order):