Helpshift APIs Android

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

Note

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

Integrating Contact Us & In App Messaging

You can use the API call help.ShowConversation(configMap) to allow a user to directly send feedback or start a new conversation without having to first view FAQs. Once, a user starts a new conversation, this API call will show the conversation screen. The conversation will continue until it is resolved or rejected by the agent. To configure SDK, you can pass various config options in a Dictionary<string, object>. Checkout more config options here

Example :

using Helpshift;

private HelpshiftSdk help;

// install call here
void Awake(){
    help = HelpshiftSdk.GetInstance();
    help.Install(appId, domainName, null);
}

void openHelpshift(){
    // configuration map
    Dictionary<string, object> configMap = new Dictionary<string, object>
        {
            { "tags", new String[] { "foo", "bar" } },
        };

    // open the support chat screen
    help.ShowConversation(configMap);
}

Integrating FAQs

You can use the API call ShowFAQs(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.

To configure the FAQs screen, you can pass various config options in a Dictionary<string, object>. Checkout more config options here

Example :

using Helpshift;

private HelpshiftSdk help;

// install call here
void Awake(){
    help = HelpshiftSdk.GetInstance();
    help.Install(appId, domainName, null);
}

void ShowFAQs(){

    // configuration map
    Dictionary<string, object> configMap = new Dictionary<string, object>
        {  // other values
            { "tags", new String[] { "foo", "bar" } },
        };

    // open the FAQs screen
    help.ShowFAQs(configMap);

}

Showing a Particular FAQ Section

You can use the API call ShowFAQSection(sectionId, configMap) to invoke a particular section of your FAQs with its FAQ section publish-id

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.

Example :

using Helpshift;

private HelpshiftSdk help;

// install call here
void Awake(){
    help = HelpshiftSdk.GetInstance();
    help.Install(appId, domainName, null);
}

void ShowFAQSection(string sectionPublishId){

    // configuration map
    Dictionary<string, object> configMap = new Dictionary<string, object>
        {  // other values
            { "tags", new String[] { "foo", "bar" } },
        };

    // open the section with provided section id
    help.ShowFAQSection(sectionPublishId, configMap);

}

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

Showing a Particular FAQ

You can use the API ShowSingleFAQ(faqId,configMap) to show a single FAQ. You will need to pass the publish-id of the FAQ to be shown to this API.

Example :

using Helpshift;

private HelpshiftSdk help;

// install call here
void Awake(){
    help = HelpshiftSdk.GetInstance();
    help.Install(appId, domainName, null);
}

void ShowFAQs(string faqPublishId){

    // configuration map
    Dictionary<string, object> configMap = new Dictionary<string, object>
        {  // other values
            { "tags", new String[] { "foo", "bar" } },
        };

    // open particular FAQ with provided faqid
    help.ShowSingleFAQ(faqPublishId, configMap);

}

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

Closing an open SDK session

You can use the API CloseSession() to close an active SDK session. Calling this API will close any open SDK screens and invoke the corresponding lifecycle delegate methods. If no SDK session is active, calling this API will have no effect.

Note

This API is available from 10.3.0 version

HelpshiftSdk.GetInstance().CloseSession();

Getting the SDK version

You can use the API SdkVersion() to get the current version of Helpshift SDK.

Note

This API is available from 10.3.0 version.

// Returns SDK version as a string eg. "10.3.0"
string version = HelpshiftSdk.GetInstance().SdkVersion();
Debug.Log("Helpshift - SDK Version is :" + version);

Set SDK language

For more info about this API and languages you can refer here

User Hub APIs

Our new Identity system - User Hub, introduces various APIs for managing users and their data. Refer to the linked section for details.