Helpshift

Installs the Helpshift Android SDK in your app with Config.

 HashMap config = new HashMap();
 config.put("notificationIcon", R.drawable.megaphone);
 config.put("enableInAppNotification", true);
 config.put("notificationSound", R.raw.notification_sound);
 config.put("enableDialogUIForTablets", true);
 config.put("enableDefaultFallbackLanguage", false);
 

 Helpshift.install(getApplication(),
 "<YOUR_API_KEY>",
 "<yourcompany>.helpshift.com",
 "<YOUR_APP_ID>",
 config);

There are four values supported in this config -

1. notificationIcon (Default : None) - You can set this value to a resource drawable which will be used as a custom icon when showing notifications.
2. enableInAppNotification (Default : true) - when set to false; this will disable the Helpshift SDK in-app notifications poller service.
3. [since SDK version 3.7.2] notificationSound (Default : None) - you can set this value to a raw resource of audio type (.mp3/.wav etc.) which will be used as custom sound when showing notifications.
4. [since SDK version 3.8.0] enableDialogUIForTablets (Default : false) - when set to true; Helpshift SDK will be opened in Dialog mode on tablet devices.
5. [since SDK version 3.12.0] enableDefaultFallbackLanguage (Default : true) - when set to false; the Helpshift SDK will not fallback to the default language when showing FAQ. Use this if you intend to have FAQ in multiple languages but do not want to fallback to ‘English’ FAQ.

Set the session delegate for Helpshift

Provide a function to fetch custom data.

 import com.helpshift.HSCallable;
 

 String [] tags = new String [] ("hello", "world");
 

 HashMap k = new HashMap();
 k.put ("foo", "bar");
 k.put ("baz", "qux");
 k.put (Helpshift.HSTagsKey, tags);
 

 Helpshift.setMetadataCallback (new HSCallable (){
 public HashMap call() {
 return k;
 }
 });
 

Display an alert dialog, which prompts the user to rate your app, or send feedback. The alertview is not shown if a conversation is currently running with the user or if you give a null/invalid url. Example:

 String playStoreUrl = "market://details?id=<package_name>";
 AlertToRateAppListener actionListener =  new AlertToRateAppListener() {
 @Override
 public void onAction(int action) {
 String msg = "";
 switch (action) {
 case Helpshift.RateAlert.CLOSE:
 msg = "Close";
 break;
 case Helpshift.RateAlert.FEEDBACK:
 msg = "Feedback";
 break;
 case Helpshift.RateAlert.SUCCESS:
 msg = "Rate app";
 break;
 case Helpshift.RateAlert.FAIL:
 msg = "Alert did not show";
 break;
 }
 Toast.makeText(getApplicationContext(), msg, Toast.LENGTH_SHORT).show();
 }
 };
 Helpshift.showAlertToRateApp(playStoreUrl, actionListener);

You can use this api call to provide a way for the user to send feedback or start a new conversation with you.

For Example:-

 HashMap customMetadata = new HashMap();
 customMetadata.put("usertype", "paid");
 customMetadata.put("level", "7");
 customMetadata.put("score", "12345");
 

 contactUsBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 HashMap config = new HashMap ();
 config.put("gotoConversationAfterContactUs", true);
 config.put("requireEmail", true);
 config.put("showConversationResolutionQuestion", true);
 config.put(Helpshift.HSCustomMetadataKey, customMetadata);
 Helpshift.showConversation(MyActivity.this, config);
 }
 });
 

Following flags are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Helpshift SDK will land on conversation activity after starting a new conversation. If set to false Helpshift SDK will land on last activity before starting a new conversation.
2. [since SDK version 3.4.1] requireEmail (Default : false) If requireEmail flag is set to true, an e-mail address is required while starting a new conversation. Default value is false i.e. e-mail is optional.
3. [since SDK version 3.5.0] conversationPrefillText The conversationPrefillText API option will pre-fill 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 Applicable only in the showConversation API
4. [since SDK version 3.5.0] hideNameAndEmail (Default : false) If hideNameAndEmail flag is set to true, the Name and Email field will not be shown in the new conversation form. If the name and email are set via API, they will be sent along with the issue. Default value is false i.e Name and Email fields are shown
5. [since SDK version 3.6.0] enableFullPrivacy (Default : false) If enableFullPrivacy flag is set to true, no private data will be sent which can be used to identify a user. This helps developers ensure full COPPA compliance. Default value is false i.e all user data will be sent
6. [since SDK version 3.6.0] showSearchOnNewConversation (Default : false) If showSearchOnNewConversation flag is set to true, the user will be taken to a view which shows the search results for the conversation text that he has entered. 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. Alternatively he can go through one of the FAQs and find a solution to his query. Default value is false i.e no search after Send button is pressed
7. [since SDK version 3.11.0] showConversationResolutionQuestion (Default : true) When set to true (default); Helpshift SDK will show the conversation resolution question, in which the user can confirm if the conversation was resolved by clicking either the Yes or No button. When set to false, on resolution the Helpshift SDK will take the user directly to the "Start a new conversation" state.

Shows FAQ section activity with Config.

This will show a FAQ section view with list of questions in that section. The search inside this view will be limited to the specified section. You can specify a section using publish ID of that section.

For example, this can be triggered on the onClick of showFAQSectionBtn Button

 HashMap customMetadata = new HashMap();
 customMetadata.put("usertype", "paid");
 customMetadata.put("level", "7");
 customMetadata.put("score", "12345");
 

 showFAQSectionBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 HashMap config = new HashMap ();
 config.put("gotoConversationAfterContactUs", false);
 config.put("enableContactUs", Helpshift.ENABLE_CONTACT_US.NEVER);
 config.put("requireEmail", true);
 config.put("showConversationResolutionQuestion", true);
 config.put(Helpshift.HSCustomMetadataKey, customMetadata);
 Helpshift.showFAQSection(MyActivity.this, "1", config);
 }
 });
 

Following flags and options are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Helpshift SDK will land on conversation activity after starting a new conversation. If set to false Helpshift SDK will land on last activity before starting a new conversation.
2. enableContactUs (Default : Helpshift.ENABLE_CONTACT_US.ALWAYS) The enableContactUs flag will determine whether the Contact Us button is shown. The default value is Helpshift.ENABLE_CONTACT_US.ALWAYS.
3. [since SDK version 3.4.1] requireEmail (Default : false) If requireEmail flag is set to true, an e-mail address is required while starting a new conversation. Default value is false i.e. e-mail is optional.
4. [since SDK version 3.5.0] hideNameAndEmail (Default : false) If hideNameAndEmail flag is set to true, the Name and Email field will not be shown in the new conversation form. If the name and email are set via API, they will be sent along with the issue. Default value is false i.e Name and Email fields are shown
5. [since SDK version 3.6.0] enableFullPrivacy (Default : false) If enableFullPrivacy flag is set to true, no private data will be sent which can be used to identify a user. This helps developers ensure full COPPA compliance. Default value is false i.e all user data will be sent
6. [since SDK version 3.10.0] showSearchOnNewConversation (Default : false) If showSearchOnNewConversation flag is set to true, the user will be taken to a view which shows the search results for the conversation text that he has entered. 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. Alternatively he can go through one of the FAQs and find a solution to his query. This flag will be ignored if the user has conducted any search or if user is filing the issue from Question screen Default value is false i.e no search after Send button is pressed
7. [since SDK version 3.11.0] showConversationResolutionQuestion (Default : true) When set to true (default); Helpshift SDK will show the conversation resolution question, in which the user can confirm if the conversation was resolved by clicking either the Yes or No button. When set to false, on resolution the Helpshift SDK will take the user directly to the "Start a new conversation" state.
8. [since SDK version 3.11.0] withTagsMatching The withTagsMatching option will be a Map containing 2 keys
   • "operator" : one of “and”, “or”, “not” which will serve as conditional operators for the given tags (String).
   • "tags" : the actual tags in the query (String Array)
   Example: This will show all FAQs with tags “android-phone” or “android-tablet”: Map filterTagsConfig = new HashMap<>(); String operator = "or"; String[] filterTags = new String[]{"android-phone", "android-tablet"}; map.put("operator", operator); map.put("tags", filterTags); HashMap config = new HashMap(); config.put("withTagsMatching", filterTagsConfig); Helpshift.showFAQSection(MyActivity.this, "1", config);

Shows faqs activity. This will show list of sections with search.

 HashMap customMetadata = new HashMap();
 customMetadata.put("usertype", "paid");
 customMetadata.put("level", "7");
 customMetadata.put("score", "12345");
 

 showFaqsBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 HashMap config = new HashMap ();
 config.put("gotoConversationAfterContactUs", true);
 config.put("enableContactUs", Helpshift.ENABLE_CONTACT_US.ALWAYS);
 config.put("requireEmail", true);
 config.put("showConversationResolutionQuestion", true);
 config.put(Helpshift.HSCustomMetadataKey, customMetadata);
 Helpshift.showFAQs(MyActivity.this, config);
 }
 });
 

Following flags and options are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Helpshift SDK will land on conversation activity after starting a new conversation. If set to false Helpshift SDK will land on last activity before starting a new conversation.
2. enableContactUs (Default : Helpshift.ENABLE_CONTACT_US.ALWAYS) The enableContactUs flag will determine whether the Contact Us button is shown. The default value is Helpshift.ENABLE_CONTACT_US.ALWAYS.
3. [since SDK version 3.4.1] requireEmail (Default : false) If requireEmail flag is set to true, an e-mail address is required while starting a new conversation. Default value is false i.e. e-mail is optional.
4. [since SDK version 3.5.0] hideNameAndEmail (Default : false) If hideNameAndEmail flag is set to true, the Name and Email field will not be shown in the new conversation form. If the name and email are set via API, they will be sent along with the issue. Default value is false i.e Name and Email fields are shown
5. [since SDK version 3.6.0] enableFullPrivacy (Default : false) If enableFullPrivacy flag is set to true, no private data will be sent which can be used to identify a user. This helps developers ensure full COPPA compliance. Default value is false i.e all user data will be sent
6. [since SDK version 3.10.0] showSearchOnNewConversation (Default : false) If showSearchOnNewConversation flag is set to true, the user will be taken to a view which shows the search results for the conversation text that he has entered. 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. Alternatively he can go through one of the FAQs and find a solution to his query. This flag will be ignored if the user has conducted any search or if user is filing the issue from Question screen Default value is false i.e no search after Send button is pressed
7. [since SDK version 3.11.0] showConversationResolutionQuestion (Default : true) When set to true (default); Helpshift SDK will show the conversation resolution question, in which the user can confirm if the conversation was resolved by clicking either the Yes or No button. When set to false, on resolution the Helpshift SDK will take the user directly to the "Start a new conversation" state.
8. [since SDK version 3.11.0] withTagsMatching The withTagsMatching option will be a Map containing 2 keys
   • "operator" : one of “and”, “or”, “not” which will serve as conditional operators for the given tags (String).
   • "tags" : the actual tags in the query (String Array)
   Example: This will show all FAQs with tags “android-phone” or “android-tablet”: Map filterTagsConfig = new HashMap<>(); String operator = "or"; String[] filterTags = new String[]{"android-phone", "android-tablet"}; map.put("operator", operator); map.put("tags", filterTags); HashMap config = new HashMap(); config.put("withTagsMatching", filterTagsConfig); Helpshift.showFAQs(MyActivity.this, config);

Shows question activity with Config.

This provides show question view provided a publish id of that section. For example, this can be triggered on the onClick of showSingleFAQBtn Button.

 HashMap customMetadata = new HashMap();
 customMetadata.put("usertype", "paid");
 customMetadata.put("level", "7");
 customMetadata.put("score", "12345");
 

 showSingleFAQBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 HashMap config = new HashMap ();
 config.put("gotoConversationAfterContactUs", false);
 config.put("enableContactUs", Helpshift.ENABLE_CONTACT_US.NEVER);
 config.put("requireEmail", true);
 config.put("showConversationResolutionQuestion", true);
 config.put(Helpshift.HSCustomMetadataKey, customMetadata);
 Helpshift.showSingleFAQ(MyActivity.this, "1", config);
 }
 });
 

Following flags are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Helpshift SDK will land on conversation activity after starting a new conversation. If set to false Helpshift SDK will land on last activity before starting a new conversation.
2. enableContactUs (Default : Helpshift.ENABLE_CONTACT_US.ALWAYS) The enableContactUs flag will determine whether the Contact Us button is shown. The default value is Helpshift.ENABLE_CONTACT_US.ALWAYS.
3. [since SDK version 3.4.1] requireEmail (Default : false) If requireEmail flag is set to true, an e-mail address is required while starting a new conversation. Default value is false i.e. e-mail is optional.
4. [since SDK version 3.5.0] hideNameAndEmail (Default : false) If hideNameAndEmail flag is set to true, the Name and Email field will not be shown in the new conversation form. If the name and email are set via API, they will be sent along with the issue. Default value is false i.e Name and Email fields are shown
5. [since SDK version 3.6.0] enableFullPrivacy (Default : false) If enableFullPrivacy flag is set to true, no private data will be sent which can be used to identify a user. This helps developers ensure full COPPA compliance. Default value is false i.e all user data will be sent
6. [since SDK version 3.11.0] showConversationResolutionQuestion (Default : true) When set to true (default); Helpshift SDK will show the conversation resolution question, in which the user can confirm if the conversation was resolved by clicking either the Yes or No button. When set to false, on resolution the Helpshift SDK will take the user directly to the "Start a new conversation" state.