SDK Configuration

Helpshift provides several config options which can be used to customize behaviour of the SDK.

Install time configurations

enableInAppNotification

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

Flag
enableInAppNotification
Values
true / false
Default
false

Example:

HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                         .SetEnableInAppNotifications(true)
                                         .Build();
HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   installConfig);

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

Example:

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("enableInAppNotification", "yes");
HelpshiftCore.Initialize(HelpshiftApiProviderType.HelpshiftApiProviderTypeAll);
HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   config);

enableDefaultFallbackLanguage

This option enables or disables fallback to default language that is English for FAQs.

This option enables or disables fallback to default language that is English for FAQs. In case you have FAQs in multiple languages but do not wish to fallback to English if localisation is missing, set this flag to 'false’.

For example if the SDK language is set to French and this option is set to true, then the FAQs for which french translation is available will be displayed in french and for the FAQs for which french translation is not available will be displayed in English. If the value of this option is set to false then the FAQs for French translation will be displayed, and the FAQs for which the translation is not provided will not be displayed at all.

Option
enableDefaultFallbackLanguage
Values
true / false
Default
true

Example:

HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                         .SetEnableDefaultFallbackLanguage(true)
                                         .Build();
HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   installConfig);

Option
enableDefaultFallbackLanguage
Values
@"yes" / @"no"
Default
@"yes"

Example:

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("enableDefaultFallbackLanguage", "no");

HelpshiftCore.Initialize(HelpshiftApiProviderType.HelpshiftApiProviderTypeAll);
HelpshiftApi.HelpshiftCore.Install("YOUR_API_KEY",
                                    "<YOUR_HELPSHIFT_DOMAIN>.helpshift.com",
                                    "YOUR_APP_ID",
                                    config);

This configuration does not apply to the Answer Bot suggested FAQs.

enableLogging

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

Option
enableLogging
Values
true / false
Default
true

Example :

HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                           .SetEnableLogging(true)
                                           .Build();
HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                               "<YOUR_COMPANY>.helpshift.com",
                               "<YOUR_APP_ID>",
                               installConfig);

Option
enableLogging
Values
"yes" / "no"
Default
"yes"

Example :

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("enableLogging", "yes");

HelpshiftCore.Initialize(HelpshiftApiProviderType.HelpshiftApiProviderTypeAll);
HelpshiftApi.HelpshiftCore.Install("YOUR_API_KEY",
                                   "<YOUR_HELPSHIFT_DOMAIN>.helpshift.com",
                                   "YOUR_APP_ID",
                                   config);

enableInboxPolling

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 false.

Flag
enableInboxPolling
Values
true / false
Default
true

Example :

HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                         .SetEnableInboxPolling(false)
                                         .Build();
HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   installConfig);

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

Example :

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("enableInboxPolling", "yes");

HelpshiftCore.Initialize(HelpshiftApiProviderType.HelpshiftApiProviderTypeAll);
HelpshiftApi.HelpshiftCore.Install("YOUR_API_KEY",
                                   "<YOUR_HELPSHIFT_DOMAIN>.helpshift.com",
                                   "YOUR_APP_ID",
                                   config);

API options

enableContactUs

The enableContactUs flag controls the visibility of Contact Us button -

Always
show in the navigation bar, search, and after marking an FAQ unhelpful.
AfterViewingFaqs
show only while searching, and after marking an FAQ unhelpful.
Never
do not show "Contact Us" button anywhere in the SDK.

Option:
enableContactUs
Values:
HsEnableContactUs.Always / HsEnableContactUs.AfterViewingFAQs / HsEnableContactUs.Never
Default:
HsEnableContactUs.Always
Supported by:
showFAQs, showFAQSection, showSingleFAQ

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetEnableContactUs(HsEnableContactUs.AfterViewingFAQs)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

Option:
enableContactUs
Values:
"always" / "after_viewing_faqs" / "never"
Default:
"always"
Supported by:
showFAQs, showFAQSection, showSingleFAQ

Example:

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("enableContactUs", "always");
Helpshift.ShowFAQs(uiViewController, config);

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

gotoConversationAfterContactUs

This API configuration is now deprecated with SDK v3.0.

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.

Option
gotoConversationAfterContactUs
Values
true / false
Default
false
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetGotoConversationAfterContactUs(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

For ShowFAQs, ShowFAQSection and ShowSingleFAQ, setting gotoConversationAfterContactUs makes sense only if enableContactUs is yes.

Option
gotoConversationAfterContactUs
Values
"yes" / "no"
Default
"no"
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

Example:

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("gotoConversationAfterContactUs", "yes");
HelpshiftApi.HelpshiftSupport.ShowConversation(uiViewController, config);

For ShowFAQs, ShowFAQSection and ShowSingleFAQ, setting gotoConversationAfterContactUs makes sense only if enableContactUs is yes.

requireEmail

This API configuration is now deprecated with SDK v3.0.

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

When the flag is set to true, customer's email will be required. If set to false, email will be optional.

Option
requireEmail
Values
true / false
Default
false
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation
HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetRequireEmail(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

Option
requireEmail
Values
"yes" / "no"
Default
"no"
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation
Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("requireEmail", "yes");
HelpshiftApi.HelpshiftSupport.ShowConversation(uiViewController, 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

This API configuration is now deprecated with SDK v3.0.

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

When the flag is set to true 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 false and email is not available to the SDK, then hideNameAndEmail flag will be ignored.

Option
hideNameAndEmail
Values
true / false
Default
false
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation
HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetHideNameAndEmail(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

Option
hideNameAndEmail
Values
"yes" / "no"
Default
"no"
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation
Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("hideNameAndEmail", "yes");
HelpshiftApi.HelpshiftSupport.ShowConversation(uiViewController, config);

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

conversationPrefillText

This API configuration is now deprecated with SDK v3.0.

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.

Option
conversationPrefillText
Values
Non-empty string
Default
Empty string
Supported by
ShowConversation

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetConversationPrefillText("Pre fill text")
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

Option
conversationPrefillText
Values
Non-empty string
Default
Empty string
Supported by
ShowConversation

Example:

string preFillString = "Pre fill text";
Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("conversationPrefillText", preFillString);
HelpshiftApi.HelpshiftSupport.ShowConversation(uiViewController, config);

The conversationPrefillText option takes effect only for the ShowConversation API

enableFullPrivacy

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

If this flag is set to true, it enables full privacy controls for the SDK. The user can be disabled from attaching screenshots and sending personally identifiable information in meta-data. This helps developers ensure full COPPA compliance.

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

Option
enableFullPrivacy
Values
true / false
Default
false
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetEnableFullPrivacy(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

Option
enableFullPrivacy
Values
"yes" / "no"
Default
"no"
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

Example:

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("enableFullPrivacy", "yes");
HelpshiftApi.HelpshiftSupport.ShowFAQs(uiViewController, config);

  1. Once the enableFullPrivacy flag is set, the SDK will use that value for all further sessions until it is changed again.
  2. If the enableFullPrivacy flag is set, for SDK versions 2.3.1 or earlier, the email requirement is always set to optional. i.e. even if requiredEmail is true; enableFullPrivacy will override it and set email requirement as optional.
  3. If the enableFullPrivacy flag is set, for SDK versions 2.4.0 or later, the user's 'email and name will not be collected and the fields will be hidden. enableFullPrivacy flag will override all other flags pertaining to name and email field.
  4. For Xamarin SDK v3.0.0 and above, this flag is ignored in the flows created to show Dynamic forms. The following flows do not honor this flag
    • ConversationFlow
    • FAQsFlow
    • SingleFAQFlow
    • FAQSectionFlow

showSearchOnNewConversation

This API configuration is now deprecated with SDK v3.0.

If showSearchOnNewConversation flag is set to true, 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 tickets 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 a ticket.

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

Option
showSearchOnNewConversation
Values
true / false
Default
false
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

For example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetShowSearchOnNewConversation(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

Option
showSearchOnNewConversation
Values
"yes" / "no"
Default
"no"
Supported by
ShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

For example

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("showSearchOnNewConversation", "yes");
HelpshiftApi.HelpshiftSupport.ShowConversation(uiViewController, config);

The showSearchOnNewConversation option takes effect only for the showConversation API.

showConversationResolutionQuestion

This API configuration is now deprecated with SDK v3.0.

This option enables or disables the showing of the Conversation Resolution view after an Agent has marked an Issue resolved. Conversation Resolution is added to the bottom of the screen with a Yes and No button. If the user taps Yes, then this view is replaced with a Start a new conversation view. If the user taps No, then we dismiss the Conversation Resolution view and let them continue the conversation.

For v3.0 and above:

This SDK configuration is deprecated with v3.0+ and default value will be treated as false.

If you want to use this feature, you can turn the feature on and off Resolution Question from the in-app configuration page. Settings > App settings

Older SDKs will keep on working with the expectations mentioned below:

For older SDK versions v2.x and below, please read the following:

This option is set to true by default, which means that the user will be presented with Conversation Resolution view. If you wish to skip this view then the option needs to be set to false.

Flag
showConversationResolutionQuestion
Values
true / false
Default
false

Example :

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetShowConversationResolutionQuestion(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

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

Example :

Dictionary<string, object> configMap = new Dictionary<string, object>();
configMap.Add("showConversationResolutionQuestion", "yes");
HelpshiftApi.HelpshiftSupport.ShowConversation(uiViewController, configMap);

customContactUsFlows

Flag
customContactUsFlows
Values
List of Flows. See the example below to create flows.
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.

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 showHelp button (a button which triggers Helpshift SDK) in the following way :

FAQSectionFlow faqSectionFlow = new FAQSectionFlow("1509", "FAQ section");
SingleFAQFlow singleFAQFlow = new SingleFAQFlow("2998", "FAQ");
HelpshiftAPIConfig conversationConfig1 = new HelpshiftAPIConfig.Builder()
                                          .SetConversationPrefillText("Contact Us about our app")
                                          .Build();
ConversationFlow conversationFlow1 = new ConversationFlow("Converse 1", conversationConfig1);
HelpshiftAPIConfig conversationConfig2 = new HelpshiftAPIConfig.Builder()
                                 .SetConversationPrefillText("Contact Us about in-app purchases")
                                 .Build();
ConversationFlow conversationFlow2 = new ConversationFlow("Converse 2", conversationConfig2);
IList<Flow> flows = new List<Flow>() { faqSectionFlow, singleFAQFlow, conversationFlow1, 
                                       conversationFlow2 };

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetCustomContactUsFlows(flows)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

public void showHelp() {

Dictionary<string, object> faqSectionFlow = new Dictionary<string, object>();
faqSectionFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowType, HelpshiftApi.HelpshiftSupport.HsFlowTypeFaqSection);
faqSectionFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowTitle, "FAQ section");
faqSectionFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowData, "1509");

Dictionary<string, object> faqFlow = new Dictionary<string, object>();
faqFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowType, HelpshiftApi.HelpshiftSupport.HsFlowTypeSingleFaq);
faqFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowTitle, "FAQ");
faqFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowData, "2998");

Dictionary<string, object> showConversationFlow1 = new Dictionary<string, object>();
showConversationFlow1.Add(HelpshiftApi.HelpshiftSupport.HsFlowType, HelpshiftApi.HelpshiftSupport.HsFlowTypeConversation);
showConversationFlow1.Add(HelpshiftApi.HelpshiftSupport.HsFlowTitle, "Converse 1");

Dictionary<string, object> conversationConfig1 = new Dictionary<string, object>() { {"conversationPrefillText" , "Contact Us about our app"} };

showConversationFlow1.Add(HelpshiftApi.HelpshiftSupport.HsFlowConfig, conversationConfig1);

Dictionary<string, object> showConversationFlow2 = new Dictionary<string, object>();
showConversationFlow2.Add(HelpshiftApi.HelpshiftSupport.HsFlowType, HelpshiftApi.HelpshiftSupport.HsFlowTypeConversation);
showConversationFlow2.Add(HelpshiftApi.HelpshiftSupport.HsFlowTitle, "Converse 2");

Dictionary<string, object> conversationConfig2 = new Dictionary<string, object>() { {"conversationPrefillText" , "Contact Us about in-app purchases"} };

showConversationFlow2.Add(HelpshiftApi.HelpshiftSupport.HsFlowConfig, conversationConfig2);

Dictionary<string, object>[] flows =  new Dictionary<string, object>[] {
faqSectionFlow,
faqFlow,
showConversationFlow1,
showConversationFlow2
};

Dictionary<string, object> faqConfig = new Dictionary<string, object>();

faqConfig.Add(HelpshiftApi.HelpshiftSupport.HsCustomContactUsFlows, flows);
HelpshiftApi.HelpshiftSupport.ShowFAQs (uiViewController, faqConfig);
}

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

Once a particular flow is selected, the subsequent Contact Us buttons will redirect to nested customContactUsFlow if configured else to default contact us screen.

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 showHelp button (a button which triggers Helpshift SDK) in the following way :

HelpshiftAPIConfig conversationConfig1 = new HelpshiftAPIConfig.Builder()
                                          .SetConversationPrefillText("Contact Us about our app")
                                          .Build();
ConversationFlow showConversationFlow1 = new ConversationFlow("Converse 1", conversationConfig1);
HelpshiftAPIConfig conversationConfig2 = new HelpshiftAPIConfig.Builder()
                                 .SetConversationPrefillText("Contact Us about in-app purchases")
                                 .Build();
ConversationFlow showConversationFlow2 = new ConversationFlow("Converse 2", conversationConfig2);
IList<Flow> nestedFlows = new List<Flow>() { showConversationFlow1, showConversationFlow2 };
HelpshiftAPIConfig singleFAQConfig = new HelpshiftAPIConfig.Builder()
                                         .SetCustomContactUsFlows(nestedFlows)
                                         .Build();
SingleFAQFlow singleFAQFlow = new SingleFAQFlow("2998", "FAQ", singleFAQConfig);
FAQSectionFlow faqSectionFlow = new FAQSectionFlow("1", "FAQ Section");
IList<Flow> flows = new List<Flow>() { singleFAQFlow, faqSectionFlow };

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetCustomContactUsFlows(flows)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

public void showHelp() {

Dictionary<string, object> showConversationFlow1 = new Dictionary<string, object>();
showConversationFlow1.Add(HelpshiftApi.HelpshiftSupport.HsFlowType, HelpshiftApi.HelpshiftSupport.HsFlowTypeConversation);
showConversationFlow1.Add(HelpshiftApi.HelpshiftSupport.HsFlowTitle, "Converse 1");
Dictionary<string, object> conversationConfig1 = new Dictionary<string, object>() { {"conversationPrefillText" , "Contact Us about our app"} };
showConversationFlow1.Add(HelpshiftApi.HelpshiftSupport.HsFlowConfig, conversationConfig1);

Dictionary<string, object> showConversationFlow2 = new Dictionary<string, object>();
showConversationFlow2.Add(HelpshiftApi.HelpshiftSupport.HsFlowType, HelpshiftApi.HelpshiftSupport.HsFlowTypeConversation);
showConversationFlow2.Add(HelpshiftApi.HelpshiftSupport.HsFlowTitle, "Converse 2");
Dictionary<string, object> conversationConfig2 = new Dictionary<string, object>() { {"conversationPrefillText" , "Contact Us about in-app purchases"} };
showConversationFlow2.Add(HelpshiftApi.HelpshiftSupport.HsFlowConfig, conversationConfig2);

Dictionary<string, object> faqFlow = new Dictionary<string, object>();
faqFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowType, HelpshiftApi.HelpshiftSupport.HsFlowTypeSingleFaq);
faqFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowTitle, "FAQ");
faqFlow.Add(HelpshiftApi.HelpshiftSupport.HsFlowData, "2998");
faqFlow.Add((HelpshiftApi.HelpshiftSupport.HsCustomContactUsFlows,, new Dictionary<string, object>[] {showConversationFlow1, showConversationFlow2});

HelpshiftApi.HelpshiftSupport.showFAQs (uiViewController, faqFlow);

}

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

showConversationInfoScreen

Applicable to version 2.3.1 and above.

The showConversationInfoScreen flag will determine if the user can see the Conversation info on the conversation feed. If set to true, the Conversation ID (Issue ID) will be shown in conversation feed.

Flag
showConversationInfoScreen
Values
true/false
Default
false

Example :

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetShowConversationInfoScreen(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

Flag
showConversationInfoScreen
Values
"yes"/"no"
Default
"no"

Example :

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("showConversationInfoScreen", "yes");
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

The Conversation ID (Issue ID) will only be visible when a conversation is actually created for support teams and Automations / Agents can act on it. (This is after Answer Bot (if configured) and Identity Bot (if configured) complete their tasks.)

enableTypingIndicator

Applicable to version 2.4.0 and above.

A graphical indicator is shown to the end user if an agent is currently replying to the same conversation. The "enableTypingIndicator" flag will enable/disable this indicator.

This SDK configuration has been deprecated, since this configuration has shifted to the In-App SDK Configurations page. (Settings > App settings)

For SDK v3.0 and above, the typing indicator configuration Show Agent Typing Indicator is now part of the In-app SDK Configurations page.

If this configuration is turned ON from the configurations page OR if the SDK configuration is used, then the typing indicator will shown to end users.

Older SDKs will keep on working with the expectations mentioned below:

For older SDK versions between v2.4.0 to v2.6.0, please read the following:

Flag
enableTypingIndicator
Values
true/false
Default
false

Example :

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetEnableTypingIndicator(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

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

Example :

Dictionary<string, object> config = new Dictionary<string, object>();
config.Add("enableTypingIndicator", "yes");
HelpshiftApi.HelpshiftSupport.ShowConversation(viewController, config);

The typing indicator will be visible to end users who file new issues using v2.4+ SDKs

Configuration Summary

Configuration / 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 Supported Supported No effect Supported
showConversationResolutionQuestion Supported Supported Supported Supported
customContactUsFlows Supported Supported Supported Not Supported
showConversationInfoScreen Supported Supported Supported Supported
enableTypingIndicator Supported Supported Supported Supported