SDK Configuration

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 APIs such as showConversation, showFAQs etc.

enableInAppNotification

Flag
enableInAppNotification
Values
"yes"/ "no"
Default
"yes"

If you want to disable the in-app notifications, please set this variable to "no" in the config dictionary passed to the install.

enableContactUs

Flag
enableContactUs
Values
HS_ENABLE_CONTACT_US_ALWAYS/HS_ENABLE_CONTACT_US_NEVER/HS_ENABLE_CONTACT_US_AFTER_VIEWING_FAQS
Default
HS_ENABLE_CONTACT_US_ALWAYS

The enableContactUs flag controls the visibility of Contact Us button -

HS_ENABLE_CONTACT_US_ALWAYS
show in the navigation bar, search, and after marking an FAQ unhelpful. "yes" for SDK versions below 4.5.0
HS_ENABLE_CONTACT_US_AFTER_VIEWING_FAQS
show only while searching, on FAQ screen and after marking an FAQ unhelpful.
HS_ENABLE_CONTACT_US_NEVER
do not show "Contact Us" button anywhere in the SDK. "no" for SDK versions below 4.5.0
HS_ENABLE_CONTACT_US_AFTER_MARKING_ANSWER_UNHELPFUL
do not show "Contact Us" button until the user specifically marks an FAQ as unhelpful.

To override the default value you can pass the arguments in the options dictionary.

For example:

ValueMap config;
config[HS_ENABLE_CONTACT_US] = Value(HS_ENABLE_CONTACT_US_NEVER)
HelpshiftCocos2dx::showFAQs(config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *enableContactUs = new CCString(HS_ENABLE_CONTACT_US_NEVER);
config->setObject(enableContactUs, HS_ENABLE_CONTACT_US);
HelpshiftCocos2dx::showFAQs(config);

This flag has no effect for the showConversation API call, since there is no Contact Us button in the conversation screen.

gotoConversationAfterContactUs

Flag
gotoConversationAfterContactUs
Values
"yes"/ "no"
Default
"no"

The gotoConversationAfterContactUs flag will determine whether the user lands up in the conversation screen after starting a new conversation via "Contact Us". This only makes sense if the enableContactUs flag takes on the default value.

For example:

ValueMap config;
config[HS_GOTO_CONVERSATION_AFTER_CONTACT_US] = Value("yes");

Helpshiftcocos2dx::showFAQs(config)

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
config->setObject(new CCString("yes"), HS_GOTO_CONVERSATION_AFTER_CONTACT_US);

HelpshiftCocos2dx::showFAQs(config);

For showFAQs, showFAQSection and showSingleFAQ, setting gotoConversationAfterContactUs makes sense only if enableContactUs is yes.

presentFullScreenOniPad

Flag
presentFullScreenOniPad
Values
"yes" / "no"
Default
"no"

The presentFullScreenOniPad flag will determine whether to present support views in UIModalPresentationFullScreen or UIModalPresentationFormSheet modal presentation style in iPad.

The default value is "no", which means support views will be presented as UIModalPresentationFormSheet by default. When the value is set to "yes", support views will be presented in UIModalPresentationFullScreen.

This flag only takes effect on iPad.

requireEmail

Flag
requireEmail
Values
"yes" / "no"
Default
"no"

The requireEmail flag will determine whether email is required or optional for starting a new conversation.

When the flag is set to yes customer's email will be required. If set to no email will be optional.

For example:

ValueMap config;
config[HS_REQUIRE_EMAIL] = Value("yes")
HelpshiftCocos2dx::showFAQs(config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *requireEmail = new CCString("yes");
config->setObject(requireEmail, HS_REQUIRE_EMAIL);
HelpshiftCocos2dx::showFAQs(config);

If "New Issue Forwarding" is ON or if "Allow anonymous issues" is ON in the agent dashboard, then this flag will be ignored.

Once requireEmail flag is set, the SDK will use that value for all new conversations until it is changed again.

hideNameAndEmail

Flag
hideNameAndEmail
Values
"yes" / "no"
Default
"no"

The hideNameAndEmail flag will hide the name and email fields when the user starts a new conversation.

When the flag is set to yes the name and email fields will be hidden. If set to no the default behaviour will resume.

If "New Issue Forwarding" is ON then this flag will be ignored when name and email are not available to the SDK. You can use the setNameAndEmail API, to supply the SDK with name and email in this case.

If "Allow anonymous issues" is ON, under app settings in the agent dashboard, then this flag will be ignored.

Also, if the requireEmail flag is set to no and email is not available to the SDK, then hideNameAndEmail flag will be ignored.

For example:

ValueMap config;
config[HS_HIDE_NAME_AND_EMAIL] = Value("yes")
HelpshiftCocos2dx::showFAQs(config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *hideNameEmail = new CCString("yes");
config->setObject(hideNameEmail, HS_HIDE_NAME_AND_EMAIL);
HelpshiftCocos2dx::showFAQs(config);

Once hideNameAndEmail flag is set, the SDK will use that value for all new conversations until it is changed again.

conversationPrefillText

Flag
conversationPrefillText
Values
Non-empty string

The conversationPrefillText API option will prefill a new conversation description, with the supplied string. This is useful where you might want your users to send you diagnostic information in the conversation description, for example if the app hits an exception, etc.

For example:

ValueMap config;
config[HS_CONVERSATION_PREFILL_TEXT] = Value("This is prefilled")
HelpshiftCocos2dx::showConversation(config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *prefill = new CCString("This is prefilled");
config->setObject(HS_CONVERSATION_PREFILL_TEXT);
HelpshiftCocos2dx::showConversation(config);

The conversationPrefillText option takes effect only for the showConversation API.

enableFullPrivacy

Flag
enableFullPrivacy
Values
"yes" / "no"
Default
"no"

In scenarios where the user attaches objectionable content in the screenshots, it becomes a huge COPPA concern. The enableFullPrivacy option will help solve this problem.

If enableFullPrivacy option is set to "yes", HS SDK does the following:

  1. Disables user-initiated screenshots - players cannot send images without being requested by an Agent.
  2. Does not collect any of the following personal information:
    • Mobile country code, mobile network code and carrier name.
    • Country code and country.
    • Custom meta-data that is labeled "private-data".

To send personally identifiable information through custom meta-data, the information must be added inside a dictionary with a "private-data" key. If this option is set to YES, this data will be removed when the user starts a new conversation.

For example:

ValueMap config;
config[HS_ENABLE_FULL_PRIVACY] = Value("yes")
HelpshiftCocos2dx::showConversation(config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *enableFullPrivacy = new CCString("yes");
config->setObject(enableFullPrivacy, HS_ENABLE_FULL_PRIVACY);
HelpshiftCocos2dx::showConversation(config);

Best Practices

In your registration process, ask your user for his/her age. If the user's age is 13 or younger, set enableFullPrivacy to "yes". This way, you comply with COPPA for your children users, but collect valuable user and device data for your other users.

  1. Once enableFullPrivacy flag is set, the SDK will use that value for all further sessions until it is changed again.
  2. For SDK versions 1.6.0 and below, if the enableFullPrivacy flag is set, the email collection requirement is always set to optional. If requiredEmail is true, enableFullPrivacy will override this configuration and set the email requirement as optional. For hiding name and email for all users, developers enable a Dashboard configuration named "Allow anonymous issues".
  3. For SDK versions 1.7.0 and above, if the enableFullPrivacy flag is set, email and name will not be collected and the fields will be hidden. enableFullPrivacy will override all other flags pertaining to name and email fields. This will allow developers to hide name and email for a specific set of users exposed to the enableFullPrivacy flag.

showSearchOnNewConversation

Flag
showSearchOnNewConversation
Values
"yes" / "no"
Default
"no"

If showSearchOnNewConversation flag is set to yes, the user will be taken to a view which shows the search results relevant to the conversation text that he has entered upon clicking the 'Send' button. This is to avoid issues which are already answered in the FAQs. The user will still be able to start a new conversation with the same text. He can also go through one of the FAQs and find a solution to his query, and exit the session without submitting an issue.

Default value is no, ie., this feature will not be enabled unless you explicitly pass yes for this flag.

For example:

ValueMap config;
config[HS_SHOW_SEARCH_ON_NEW_CONVERSATION] = Value("yes")
HelpshiftCocos2dx::showConversation(config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *showSearchOnNewConversation = new CCString("yes");
config->setObject(showSearchOnNewConversation, HS_SHOW_SEARCH_ON_NEW_CONVERSATION);
HelpshiftCocos2dx::showConversation(config);

The conversationPrefillText option takes effect only for the showConversation API.

showConversationResolutionQuestion

Flag
showConversationResolutionQuestion
Values
"yes"/"no"
Default
"yes"

By default the Helpshift SDK will show the conversation resolution question to the user, to confirm if the conversation was resolved. On resolving the conversation from the admin dashboard will now take the user directly to the "Start a new conversation" state. If you want to disable the conversation resolution question, set showConversationResolutionQuestion to no.

Default value is yes, ie., this feature will not be disabled unless you explicitly pass false for this flag.

For example:

ValueMap config;
config[HS_SHOW_CONVERSATION_RESOLUTION_QUESTION] = Value("no")
HelpshiftCocos2dx::showConversation(config);

std::string conversationResolutionQuestion = "no";
config[HS_SHOW_CONVERSATION_RESOLUTION_QUESTION] = conversationResolutionQuestion;
HelpshiftCocos2dx::showConversation(config);

enableDefaultFallbackLanguage

Flag
enableDefaultFallbackLanguage
values
"yes"/"no"
default
"yes"

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. This flag is to be passed only in the config for the HelpshiftCocos2dx::install call.

For example:

ValueMap config;
config[HS_ENABLE_DEFAULT_FALL_BACK_LANGUAGE] = Value("yes")

#if (CC_TARGET_PLATFORM == CC_PLATFORM_IOS)
HelpshiftCocos2dx::install("apikey",
                           "domain.helpshift.com",
                           "appId",
                           config);
#endif

std::string defaultLang = "yes";
config[HS_ENABLE_DEFAULT_FALL_BACK_LANGUAGE] = defaultLang;

#if (CC_TARGET_PLATFORM == CC_PLATFORM_IOS)
HelpshiftCocos2dx::install("apikey",
                           "domain.helpshift.com",
                           "appId",
                           config);
#endif

disableEntryExitAnimations

This option disables the iOS view transition animations when launching or closing a Helpshift Support session.

Option
disableEntryExitAnimations
Values
"yes" / "no"
Default
"no"

If you want to disable the in-app notifications, please set this variable to "yes" in the config dictionary passed to the install.

customContactUsFlows

This configuration allows you to override the Contact Us buttons inside the Helpshift SDK and show Guided Issue Filing when a user taps on the Contact Us buttons.

Option
customContactUsFlows
Value
NSArray of flows. Flows can be created by using the Guided Issue Filing APIs
Default
There is no default value for this configuration.

This configuration allows you to override the Contact Us buttons inside the Helpshift SDK and show Guided Issue Filing when a user taps on the Contact Us buttons.

For example:

Let's say you want the users to see a particular FAQ section, a single FAQ and 2 different Contact Us flows with different prefill texts when they tap the Contact Us buttons within the Helpshift SDK. In this case, you would configure the menuHelpCallback (a button which triggers Helpshift SDK) in the following way :

void AppDelegate::menuHelpCallback(Ref* pSender) {
     ValueVector forms;

    ValueMap faqSectionFlow;
    faqSectionFlow[HS_FLOW_TYPE] = HS_FAQ_SECTION_FLOW;
    faqSectionFlow[HS_FLOW_TITLE] = Value("FAQ Section");
    faqSectionFlow[HS_FLOW_DATA] = "1";
    forms.push_back(Value(faqSectionFlow));

    ValueMap singleFAQFlow;
    singleFAQFlow[HS_FLOW_TYPE] = HS_SINGLE_FAQ_FLOW;
    singleFAQFlow[HS_FLOW_TITLE] = Value("Single FAQ");
    singleFAQFlow[HS_FLOW_DATA] = "2";
    forms.push_back(Value(singleFAQFlow));

    ValueMap conversationFlow1;
    conversationFlow1[HS_FLOW_TYPE] = HS_CONVERSATION_FLOW;
    conversationFlow1[HS_FLOW_TITLE] = Value("Contact us about our app");
    forms.push_back(Value(conversationFlow1));

    ValueMap conversationFlow2;
    conversationFlow2[HS_FLOW_TYPE] = HS_CONVERSATION_FLOW;
    conversationFlow2[HS_FLOW_TITLE] = Value("Contact us about our in-app purchase");
    forms.push_back(Value(conversationFlow2));

    ValueMap showFAQsConfig;
    showFAQsConfig[HS_CUSTOM_CONTACT_US_FLOWS] = Value(forms);
    showFAQsConfig[HS_ENABLE_CONTACT_US] = Value("yes");

    HelpshiftCocos2dx::showFAQs(showFAQsConfig);
}

void AppDelegate::menuHelpCallback(Ref* pSender) {
    cocos2d::CCArray *forms = CCArray::create();

    cocos2d::CCDictionary *singleSectionForm = CCDictionary::create();
    singleSectionForm->setObject(new CCString(HS_SINGLE_FAQ_FLOW), HS_FLOW_TYPE);
    singleSectionForm->setObject(new CCString("Single Section"), HS_FLOW_TITLE);
    singleSectionForm->setObject(new CCString("95"), HS_FLOW_DATA);
    forms->addObject(singleSectionForm);

    cocos2d::CCDictionary *singleFAQForm = CCDictionary::create();
    singleFAQForm->setObject(new CCString(HS_FAQ_SECTION_FLOW), HS_FLOW_TYPE);
    singleFAQForm->setObject(new CCString("Single FAQ"), HS_FLOW_TITLE);
    singleFAQForm->setObject(new CCString("9"), HS_FLOW_DATA);
    forms->addObject(singleFAQForm);

    cocos2d::CCDictionary *conversationFlow1 = CCDictionary::create();
    conversationFlow1->setObject(new CCString(HS_CONVERSATION_FLOW), HS_FLOW_TYPE);
    conversationFlow1->setObject(new CCString("Contact us about our app"), HS_FLOW_TITLE);
    forms->addObject(conversationFlow1);

    cocos2d::CCDictionary *conversationFlow2 = CCDictionary::create();
    conversationFlow2->setObject(new CCString(HS_CONVERSATION_FLOW), HS_FLOW_TYPE);
    conversationFlow2->setObject(new CCString("Contact us about our
    in-app purchase"), HS_FLOW_TITLE);
    forms->addObject(conversationFlow2);

    cocos2d::CCDictionary *showFAQsConfig = CCDictionary::create();
    showFAQsConfig->setObect(forms, HS_CUSTOM_CONTACT_US_FLOWS);

    HelpshiftCocos2dx::showFAQs(showFAQsConfig);
}

Anytime the Helpshift SDK is presented via menuHelpCallback with this configuration, the Contact Us buttons in the SDK will redirect to Guided Issue Filing with the flows provided in the HS_CUSTOM_CONTACT_US_FLOWS list.

Once a particular flow is selected, the subsequent Contact Us buttons will not redirect to Guided Issue Filing again. They will function as normal Contact Us buttons. This is to avoid an infinite loop of Guided Issue Filing screens.

Custom flows can be nested by passing another custom flows configuration while creating a flow.

Example :

Let's say you want to configure singleFAQFlow in the above example to show showConversationFlow1 and showConversationFlow2 through the Contact Us buttons inside it. In this case, you would configure the menuHelpCallback button (a button which triggers Helpshift SDK) in the following way :

void AppDelegate::menuHelpCallback(Ref* pSender) {
    ValueVector forms;

    ValueMap faqSectionFlow;
    faqSectionFlow[HS_FLOW_TYPE] = HS_FAQ_SECTION_FLOW;
    faqSectionFlow[HS_FLOW_TITLE] = Value("FAQ Section");
    faqSectionFlow[HS_FLOW_DATA] = "1";
    forms.push_back(Value(faqSectionFlow));

    ValueVector nestedCustomContactUsFlows;

    ValueMap conversationFlow1;
    conversationFlow1[HS_FLOW_TYPE] = HS_CONVERSATION_FLOW;
    conversationFlow1[HS_FLOW_TITLE] = Value("Contact us about our app");
    nestedCustomContactUsFlows.push_back(Value(conversationFlow1));

    ValueMap conversationFlow2;
    conversationFlow2[HS_FLOW_TYPE] = HS_CONVERSATION_FLOW;
    conversationFlow2[HS_FLOW_TITLE] = Value("Contact us about our in-app purchase");
    nestedCustomContactUsFlows.push_back(Value(conversationFlow2));

    ValueMap singleFAQFlowConfig;
    ingleFAQFlowConfig[HS_CUSTOM_CONTACT_US_FLOWS] = Value(nestedCustomContactUsFlows);

    ValueMap singleFAQFlow;
    singleFAQFlow[HS_FLOW_TYPE] = HS_SINGLE_FAQ_FLOW;
    singleFAQFlow[HS_FLOW_TITLE] = Value("Single FAQ");
    singleFAQFlow[HS_FLOW_DATA] = "2";
    singleFAQFlow[HS_FLOW_CONFIG] = Value(singleFAQFlowConfig);
    forms.push_back(Value(singleFAQFlow));

    ValueMap showFAQsConfig;
    showFAQsConfig[HS_CUSTOM_CONTACT_US_FLOWS] = Value(forms);

    HelpshiftCocos2dx::showFAQs(showFAQsConfig);
}

void AppDelegate::menuHelpCallback(Ref* pSender) {
     cocos2d::CCArray *forms = CCArray::create();
     cocos2d::CCDictionary *faqSectionFlow = CCDictionary::create();

    faqSectionFlow->setObject(new CCString(HS_FAQ_SECTION_FLOW), HS_FLOW_TYPE);
    faqSectionFlow->setObject(new CCString("FAQ Section"), HS_FLOW_TITLE);
    faqSectionFlow->setObject(new CCString("9"), HS_FLOW_DATA);
    forms->addObject(faqSectionFlow);

    cocos2d::CCArray *nestedCustomContactUsFlows = CCArray::create();

    cocos2d::CCDictionary *conversationFlow1 = CCDictionary::create();
    conversationFlow1->setObject(new CCString(HS_CONVERSATION_FLOW), HS_FLOW_TYPE);
    conversationFlow1->setObject(new CCString("Contact us about our app"), HS_FLOW_TITLE);
    nestedCustomContactUsFlows->addObject(conversationFlow1);

    cocos2d::CCDictionary *conversationFlow2 = CCDictionary::create();
    conversationFlow2->setObject(new CCString(HS_CONVERSATION_FLOW), HS_FLOW_TYPE);
    conversationFlow2->setObject(new CCString("Contact us about our in-app purchase"), HS_FLOW_TITLE);
    nestedCustomContactUsFlows->addObject(conversationFlow2);

    cocos2d::CCDictionary *singleFAQFlowConfig = CCDictionary::create();
    singleFAQFlowConfig->setObject(nestedCustomContactUsFlows, HS_CUSTOM_CONTACT_US_FLOWS);

    cocos2d::CCDictionary *singleFAQFlow = CCDictionary::create();
    singleFAQFlow->setObject(new CCString(HS_SINGLE_FAQ_FLOW), HS_FLOW_TYPE);
    singleFAQFlow->setObject(new CCString("Single FAQ"), HS_FLOW_TITLE);
    singleFAQFlow->setObject(new CCString("9"), HS_FLOW_DATA);
    singleFAQFlow->setObject(singleFAQFlowConfig, HS_FLOW_CONFIG);
    forms->addObject(singleFAQFlow);

    cocos2d::CCDictionary *showFAQsConfig = CCDictionary::create();
    showFAQsConfig->setObject(forms, HS_CUSTOM_CONTACT_US_FLOWS);

    HelpshiftCocos2dx::showFAQs(showFAQsConfig);
}

With this configuration, the Contact Us buttons in singleFAQFlow View will redirect to Guided Issue Filing with showConversationFlow1 and showConversationFlow2.

This configuration will work only when there is no open conversation for the user, otherwise every Contact Us button will transition to the chat screen.

Add FAQs to Spotlight search

Search in iOS 9 gives users great new ways to access information inside of your app. When you make your content searchable, users can access activities and content deep within your app through Spotlight and Safari search results, Handoff, and Siri suggestions. Using APIs related to search, you decide what content gets indexed, what information to show in search results, and where the user is redirected after tapping a result from your app.

The Helpshift SDK can now use these new APIs to add all of your FAQs to the on-device search index. This will ensure that the FAQs that you have added will get maximum visibility. This will also help ensure that your users find solutions to their problems easily and help reduce support issues and eventually churn.

Flag
addFaqsToDeviceSearch
Values
on_install / after_viewing_faqs / never

on_install : This will fetch and add FAQs to the CoreSpotlight index right after your application calls Helpshift's install method. We will make sure to do all the fetching on background threads so that we do not affect the Application's responsiveness. Since FAQs are not something that is updated very frequently, we have capped the number of fetches to only 4 per day. So in-effect the SDK will scan for new FAQs only once every 6 hours.

after_viewing_faqs : This will add FAQs to the CoreSpotlight index only after the user actually opens the Help section (wired to the showFAQs and showFAQSection APIs).

never : The Helpshift SDK will not add FAQs to the CoreSpotlight index.

For the search entry to launch the appropriate FAQ screen, the application should forward the hand off delegate to Helpshift via the

[HelpshiftSupport handleContinueUserActivity:userActivity withController:viewController andRestorationHandler:restorationHandler]

For example:

- (BOOL) application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *))restorationHandler {
    NSString *activityIdentifier = [userActivity.userInfo objectForKey:CSSearchableItemActivityIdentifier];
    if(activityIdentifier && [activityIdentifier hasPrefix:@"helpshift_faq_"]) {
        return [HelpshiftSupport handleContinueUserActivity:userActivity withController:[UIApplication sharedApplication].keyWindow.rootViewController andRestorationHandler:restorationHandler];
    }
    return NO;
}

enableLogging

Upon setting enableLogging to true, Helpshift SDK logs will be generated in the Xcode console. This will be useful for debugging the SDK during integration.

Flag:
enableLogging
Values:
"yes" / "no"
Default:
"no"

For example:

ValueMap config;
config[HS_ENABLE_LOGGING] = Value("yes");

HelpshiftCocos2dx::install("apikey",
                           "domain.helpshift.com",
                           "appId",
                           config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *enableLogging = new CCString("yes");
config->setObject(enableLogging, HS_ENABLE_LOGGING);

HelpshiftCocos2dx::install("apikey",
                           "domain.helpshift.com",
                           "appId",
                           config);

enableInboxPolling

This change controls whether or not the application should poll for Campaign messages in addition to relying on push notifications. If your application does not use this option, the SDK will use both push notifications and polling to receive Campaign messages. If you want to use only push notifications for Campaigns, set this option to NO.

Flag:
enableInboxPolling
Values:
"yes" / "no"
Default:
"yes"

For example:

ValueMap config;
config[HS_ENABLE_INBOX_POLLING] = Value("no");

HelpshiftCocos2dx::install("apikey",
                           "domain.helpshift.com",
                           "appId",
                           config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
CCString *enableInboxPolling = new CCString("no");
config->setObject(enableInboxPolling, HS_ENABLE_INBOX_POLLING);

HelpshiftCocos2dx::install("apikey",
                           "domain.helpshift.com",
                           "appId",
                           config);

enableTypingIndicator

Typing indicator will be enabled only for issues filed with SDK v1.7.0 and above.

A graphical indicator is shown to the end user if an Agent is currently replying to the same conversation. The HS_ENABLE_TYPING_INDICATOR flag will enable/disable the aforementioned indicator.

Flag:
enableTypingIndicator
Values:
"yes" / "no"
Default:
"no"

For example:

ValueMap config;
config[HS_ENABLE_TYPING_INDICATOR] = Value("yes");
Helpshiftcocos2dx::showFAQs(config);

cocos2d::CCDictionary *config = new cocos2d::CCDictionary();
config->setObject(new CCString("yes"), HS_ENABLE_TYPING_INDICATOR);
HelpshiftCocos2dx::showFAQs(config);

Configuration Summary

Option / API showFAQs showFAQSection showSingleFAQ showConversation
enableContactUs Supported Supported Supported Not Supported
gotoConversationAfterContactUs Supported Supported Supported Supported
presentFullScreenOniPad Supported Supported Supported Supported
requireEmail Supported Supported Supported Supported
hideNameAndEmail Supported Supported Supported Supported
conversationPrefillText No effect No effect No effect Supported
enableFullPrivacy Supported Supported Supported Supported
showSearchOnNewConversation No effect No effect No effect Supported
showConversationResolutionQuestion Supported Supported Supported Supported
customContactUsFlows Supported Supported Supported Not Supported
helpshiftFAQSpotlightSearch Not Supported Not Supported Not Supported Not Supported
enableLogging Not Supported Not Supported Not Supported Not Supported
enableInboxPolling Not Supported Not Supported Not Supported Not Supported
enableTypingIndicator Supported Supported Supported Supported