Getting Started iOS

Requirements

• Xcode 10.2 and above.
• Supported iOS versions:
  • iOS iOS 13, 12, 11 and 10

Download the Cocos2d-x plugin for Helpshift

Helpshift Cocos2d-x package comes in two variants:

1. Standard SDK - In-app Customer Service

Download SDK v5.3.1

2. Campaigns-enabled SDK - Proactive In-app Customer Service

Download SDK v5.3.1-withCampaigns

The zip file contains:

Adding the Helpshift iOS plugin

1. Add the following frameworks to Link Binary with Libraries -

   • CoreGraphics
   • QuartzCore
   • CoreText
   • SystemConfiguration
   • CoreTelephony
   • UIKit
   • libsqlite3.tbd
   • libicucore.tbd
   • libz.tbd
   • Security
   • QuickLook
   • CoreLocation
   • MobileCoreServices
   • CoreSpotlight
   • Photos
   • WebKit
   • GameController (required by cocos2d-x)
   • MediaPlayer (required by cocos2d-x)

2. Add the contents of the ios/Classes folder into your Xcode project.

3. Add the ios/sdk folder to your Xcode project to add the Helpshift iOS native SDK.

• If your app does not contain any swift code, follow the additional steps:

  • Set Always Embed Swift binaries in the build settings to YES
  • Add /usr/lib/swift to the runpath search paths in the build settings. Make sure it is above the $(inherited) and @executable_path/Frameworks flags
  • Add $(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME) for Xcode 11.x or $(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME) for Xcode 10.x to the Library Search Paths in the build settings.

• With version 5.3.0, End-users will be able to send files such as pdf, video, etc. where before 5.3.0 end-users could only send images. For iOS 10 and below, to access files in the “Files” app of iOS, developers will need to add iCloud capability with iCloud Documents services enabled. For more info please refer the Prerequisites section here.    show me

Initializing Helpshift in your App

Helpshift SDK uniquely identifies your App with the combination of:

To get the API Key, Domain Name and the App ID, navigate to Settings>SDK (for Developers) in your agent dashboard and scroll down to "Initializing Helpshift" section. show me

Select your App from the dropdown and copy the three tokens to be passed when initializing Helpshift.

Initialize Helpshift by including HelpshiftCocos2dx.h and calling HelpshiftCocos2dx::install in the AppDelegate::applicationDidFinishLaunching() function of your AppDelegate.cpp:

#include "HelpshiftCocos2dx.h"
...

bool AppDelegate::applicationDidFinishLaunching() {

    HelpshiftCocos2dx::install("<YOUR_API_KEY>",
                               "<YOUR_HELPSHIFT_DOMAIN>.helpshift.com",
                               "<YOUR_APP_ID>");
    ...

}

Start using Helpshift

Helpshift is now integrated in your app. You should now use the support APIs to present FAQ or conversation screens inside your app.

Run your app, and try starting a test conversation using the showConversation API call. Then goto your Helpshift agent dashboard and reply to experience the in-app messaging.

Sample usage for FAQs and conversation APIs:

// Presenting FAQs to your customers
void GameSettingsScene::menuHelpCallback(CCObject* pSender)
{
    HelpshiftCocos2dx::showFAQs();
}

// Starting a conversation with your customers
void GameSettingsScene::menuConversationCallback(CCObject* pSender)
{
    HelpshiftCocos2dx::showConversation();
}

Next up