SDK Configuration using Objective C

Helpshift provides several config options which can be used to customize behaviour of the SDK. These options are boolean flags which can be passed with the Helpshift Install API.

unityGameObject

Flag	unityGameObject
Values	Non-empty String

The unityGameObject option is used to tell the Helpshift SDK which Game object to send the Unity messages to. Callbacks such as didReceiveInAppNotificationCount and didReceiveNotificationCount will be called on the object specified via this option.

For example

Using Api Config object

Option:	enableInboxPolling
Values:	YES / NO
Default:	YES
Supported by:	installForApiKey:domainName:appId:

Example:

    HelpshiftInstallConfigBuilder *installConfigBuilder = [[HelpshiftInstallConfigBuilder alloc] init];
    installConfigBuilder.extraConfig = @{@"unityGameObject":@"Cube"};
    HelpshiftInstallConfig *installConfig = [installConfigBuilder build];
    [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]];
    [HelpshiftCore installForApiKey:@"YOUR_API_KEY" domainName:@"YOUR_DOMAIN_NAME" appID:@"YOUR_APP_ID" withConfig:installConfig];

Using Dictionary

Option:	enableInboxPolling
Values:	@"YES" / @"NO"
Default:	@"NO"
Supported by:	installForApiKey:domainName:appId:

Example:

    [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]];
    NSDictionary *installConfig = @{ @"unityGameObject" : @"Cube"};

    [HelpshiftCore installForApiKey:@"" domainName:@"" appID:@"" withOptions:installConfig];

enableInAppNotification

If you do not want the in-app notification support provided by the Helpshift SDK, you can set the flag to no. The default value of this flag is yes i.e., in app notification will be enabled.

For example

Using Api Config object

Option:	enableInboxPolling
Values:	YES / NO
Default:	YES
Supported by:	installForApiKey:domainName:appId:

Example:

    HelpshiftInstallConfigBuilder *installConfigBuilder = [[HelpshiftInstallConfigBuilder alloc] init];
    installConfigBuilder.enableInAppNotifications = NO;
    HelpshiftInstallConfig *installConfig = [installConfigBuilder build];
    [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]];
    [HelpshiftCore installForApiKey:@"YOUR_API_KEY" domainName:@"YOUR_DOMAIN_NAME" appID:@"YOUR_APP_ID" withConfig:installConfig];

Using Dictionary

Option:	enableInboxPolling
Values:	@"YES" / @"NO"
Default:	@"NO"
Supported by:	installForApiKey:domainName:appId:

Example:

    [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]];
    NSDictionary *installConfig = @{ @"enableInAppNotifications" : @"YES"};

    [HelpshiftCore installForApiKey:@"" domainName:@"" appID:@"" withOptions:installConfig];

enableDefaultFallbackLanguage

Note

Available from SDK version 1.3.0 and above

You can enable or disable the SDK default fallback language when showing FAQs using this flag. When set to false, the Helpshift SDK will not fallback to the default language that is English, when showing FAQs.

Using Api Config object

Option	enableDefaultFallbackLanguage
Values	@"YES" / @"NO"
Default	@"YES"
Min SDK	v1.3.0
Supported by	installForApiKey

Example:

    HelpshiftInstallConfigBuilder *installConfigBuilder = [[HelpshiftInstallConfigBuilder alloc] init];
    installConfigBuilder.enableDefaultFallbackLanguage = NO;
    HelpshiftInstallConfig *installConfig = [installConfigBuilder build];
    [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]];
    [HelpshiftCore installForApiKey:@"YOUR_API_KEY" domainName:@"YOUR_DOMAIN_NAME" appID:@"YOUR_APP_ID" withConfig:installConfig];

Using Dictionary

Option	enableDefaultFallbackLanguage
Values	@"YES" / @"NO"
Default	@"YES"
Min SDK	v1.3.0
Supported by	installForApiKey

Example:

    [HelpshiftCore installForApiKey:@"YOUR_API_KEY" domainName:@"YOUR_DOMAIN_NAME" appID:@"YOUR_APP_ID"
                        withOptions:@{@"enableDefaultFallbackLanguage" : @"NO"}];

disableEntryExitAnimations

Note

Applicable to version 2.1.1 and above.

If you want to disable animations shown by the Helpshift SDK while entering and exit the Helpshift screens, please set this config option to yes. Default value is no, ie., Helpshift SDK will show animations if this value is not set.

Using Api Config object

Option	disableEntryExitAnimations
Values	YES / NO
Default	NO
Min SDK	v2.1.1
Supported by	installForApiKey

Example:

    HelpshiftInstallConfigBuilder *installConfigBuilder = [[HelpshiftInstallConfigBuilder alloc] init];
    installConfigBuilder.disableEntryExitAnimations = YES;
    HelpshiftInstallConfig *installConfig = [installConfigBuilder build];
    [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]];
    [HelpshiftCore installForApiKey:@"YOUR_API_KEY" domainName:@"YOUR_DOMAIN_NAME" appID:@"YOUR_APP_ID" withConfig:installConfig];

Using Dictionary

Option	disableEntryExitAnimations
Values	@"YES" / @"NO"
Default	@"NO"
Min SDK	v2.1.1
Supported by	installForApiKey

Example:

    [HelpshiftCore installForApiKey:@"YOUR_API_KEY" domainName:@"YOUR_DOMAIN_NAME" appID:@"YOUR_APP_ID"
    withOptions:@{@"disableEntryExitAnimations" : @"YES"}];

enableLogging

Upon setting enableLogging to yes, Helpshift SDK logs will be generated in the Xcode console. Turning on logging can help developers resolve common integration issues.

Using Api Config object

Option:	enableLogging
Values:	YES / NO
Default:	NO
Supported by:	installForApiKey:domainName:appId:

Example:

    HelpshiftInstallConfigBuilder *installConfigBuilder = [[HelpshiftInstallConfigBuilder alloc] init];
    installConfigBuilder.enableLogging = YES;

    HelpshiftInstallConfig *installConfig = [installConfigBuilder build];

Using Dictionary

Option:	enableLogging
Values:	@"YES" / @"NO"
Default:	@"NO"
Supported by:	installForApiKey:domainName:appId:

Example:

    NSDictionary *installConfig = @{@"enableLogging" : @"yes"};
    [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]];
    [HelpshiftCore installForApiKey:"<YOUR_API_KEY>"
                         domainName:"<YOUR_COMPANY>.helpshift.com"
                              appID:"<YOUR_APP_ID>"
                        withOptions:installConfig];