Getting Started iOS

Guide to integrating the Unity plugin for the Helpshift SDK X which you can call from your C# and Javascript game scripts.

Requirements

• Unity 2018.1.0 and above.
• Xcode 12.0 and above.
• Supported iOS versions:
  • iOS 16, 15, 14, 13, 12, 11, and 10

Download HelpshiftX Unity SDK for iOS

Download SDK v10.2.1

HelpshiftX SDK .zip folder includes:

Add Helpshift to your Unity project

• Unzip the HelpshiftX Unity SDK package.
• HelpshiftX Unity SDK appears as a standard .unitypackage which you can import through the Unity package import procedure.
• Following are the steps to import the helpshiftX-plugin-unity-version.unitypackage into your Unity game:
  1. In the Open Unity project, navigate to Assets drop-down menu and select the Import Package > Custom Package
  2. From the unzipped SDK, select helpshiftX-plugin-unity-version.unitypackage file to import the Helpshift SDK.
  3. Click Import.

Mandatory verification step for packages downloaded from Unity Asset Store

1. On adding Helpshift package to your project you will see a menu option Helpshift/Verification in the main menu bar of Unity IDE.

2. You will need to provide the Domain name and App ID (same as Platform ID) for either Android or iOS platform and then Verify the package.

   • You can find these IDs in Step 3 below.

3. Wait for package verification to be successful.

4. This verification is mandatory to avoid Android/iOS build failures.

Info.plist changes - Addition of usage description strings

When the “User Attachments” feature is enabled from the In-app SDK Configuration section, the SDK allows the user to upload the attachments. The attachments can be picked from the Photo Library or can be captured directly using the camera. The options for these sources look like:

To use the camera and photo library, Apple requires the app to have Usage Description strings in the Info.plist while. Failing to add these strings might result in app rejection. The following strings are needed for the attachment feature:

Note that the above strings are just a suggested description. If you need localisations for the same, please Contact Us

Initializing Helpshift in your app

Helpshift's namespace

To use Helpshift's APIs, please import the Helpshift's namespace like below

using Helpshift;

1. First, create an app on the Helpshift Dashboard show me

2. Create an app with iOS as a selected Platform show me

Helpshift uniquely identifies each registered App with a combination of 2 tokens:

show me

Initialize Helpshift by calling the method install(appId, domain) API

using Helpshift;
.
.
.
public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    ...

    void Awake() {
        help = HelpshiftSdk.GetInstance();
        var configMap = new Dictionary<string, object>();
        help.Install(appId, domainName, configMap);
    }
    ...
}

Install Helpshift via ObjC

If you intend to initialize the SDK from Xcode using Objective C, You can specify Domain Name, Platform ID and other install configurations in the Objective-C code. To do this you need to override application:didFinishLaunchingWithOptions in HsUnityAppcontroller as shown below.

#import <HelpshiftX/HelpshiftX.h>
#import "HelpshiftX-Unity.h"

- (BOOL) application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Set install configurations
    NSDictionary *installConfig = @{@"enableInAppNotification":@YES};

    // Make install call
    [Helpshift installWithPlatformId:@"<your_platform_id>" domain:@"<your_domain_name>" config:installConfig];
    return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

Start using Helpshift

Helpshift is now integrated in your app. You should now use the support APIs inside your app to experience the functionality provided by the Helpshift SDK

Next up