Skip to main content

Helpshift APIs

Helpshift provides a way to use functional element of the SDK based on your requirements.

Note

All the public APIs in the SDK should be called after initializing the SDK via Helpshift.install() API

Integrating Contact Us & In App Messaging​

newConversation.png

You can call Helpshift.showConversation(MyActivity.this, configurationMap) to lead your user to your support and help section. You can pass the various configurations while opening the conversation screen which can be found here

Example:

    // config map
    Map<String, Object> config = new HashMap<>();

    // set tags for tracking
    config.put("tags", new String[]{"foo", "bar"});

    // set custom issue fields
    Map<String, Object> cifMap = new HashMap<>();
    Map<String, String> isPro = new HashMap<>();
    isPro.put("type", "boolean");
    isPro.put("value", "true");
    cifMap.put("is_pro", isPro);

    config.put("customIssueFields", cifMap);

    //..etc

    // pass the config map in the api
    Helpshift.showConversation(MainActivity.this, config);

Helpshift.showConversation(MyActivity.this, configMap); where MyActivity.this is the Activity you're calling Helpshift from and configMap is the configuration map that you want to pass to configure the SDK.

Integrating FAQs​

Example: Helpshift.showFAQs(MyActivity.this, configMap); where MyActivity.this is the Activity you're calling Helpshift from

showFAQs.png

You can use the api call Helpshift.showFAQs(Activity a, Map<String, Object> configMap) to provide a way for the user to invoke the purpose built help/support section in your app. This is the easiest approach to enable help in your app as it bundles all the capabilities of the Helpshift SDK in a simple and intuitive interface. You can wire this api call to a "Help" or "Support" action in your app. This Activity combines the FAQ, Search and Contact Us functionality together in a single interface. In this view a user has to search for a specific question in the FAQ failing which they can report an issue. When you respond back to their question from the Helpshift Agent Dashboard, the reply will be shown as a count besides Contact Us, clicking on which will open up the conversation.

Check out SDK Configuration for more.

Showing a Particular FAQ Section​

Example: Helpshift.showFAQSection(MyActivity.this, "11", configMap); where MyActivity.this is the Activity you're calling Helpshift from and "11" is the FAQ section publish-id

showFAQSection.png

You can use the api call Helpshift.showFAQSection(Activity a, String sectionPublishId, Map<String, Object> configMap) to show faqs from a particular FAQ section.

You'll need the publish-id of the section in this case:

This feature works like a permalink for displaying specific FAQ sections as context sensitive help in your app. For example, if your app requires the user to login to using email, facebook and twitter, you could wire a help action on the login screen that can link to the Helpshift FAQ section called "Login help" which has several questions related to login methods.

Check out SDK Configuration for more.

Showing a Particular FAQ Question​

Example: Helpshift.showSingleFAQ(MyActivity.this, "51", configMap); where MyActivity.this is the Activity you're calling Helpshift from and "51" is the FAQ publish-id

showSingleFAQ.png

You can use the api call Helpshift.showSingleFAQ(Activity a, String questionPublishId, Map<String, Object> configMap) to show a single faq.

You'll need the publish-id of the FAQ in this case:

Set SDK language​

You can set the SDK language for the given locale using the method setLanguage("<language-code>") For more info about languages you can refer here

For example :

Setting SDK language for the given locale with only language code.

Helpshift.setLanguage("fr");

Setting the SDK language for the given locale with both language code and country code.

Helpshift.setLanguage("zh-SG");