Helpshift

(Optional) A Reserved key constant to be used; to add custom metadata to the config HashMap. This metadata is sent to the server when the user starts a new conversation.

A Reserved key constant to be used with setMetadataCallback to pass String array which get interpreted at server and added as Tags for the conversation submitted.

A Reserved key constant to be used with setMetadataCallback to pass String array which get interpreted at server and added as Tags for the conversation submitted.

Clears Breadcrumbs list.

Breadcrumbs list stores upto 100 latest actions. You'll receive those in every Issue. But if for reason you want to clear previous messages (On app load, for eg), you can do that by calling following function.

 Helpshift.clearBreadCrumbs ();

Gets notification count asynchronously by implementing the countHandler and failHandler. The notification count can be obtained from the message received though the countHandler. Example:-

 private Handler countHandler = new Handler() {
 public void handleMessage(Message msg) {
 super.handleMessage(msg);
 Bundle countData = (Bundle) msg.obj;
 Integer count = countData.getInt("value");
 Boolean cache = countData.getBoolean("cache");
 if (cache) {
 Log.d("Notification Count", "local" + count);
 } else {
 Log.d("Notification Count", "server" + count);
 }
 }
 };
 Helpshift.getNotificationCount(countHandler, new Handler());

Gets notification count synchronously.

Ex:-

 Integer notifCount = Helpshift.getNotificationCount();

This will handle push received from Helpshift using either GCM push or Urban Airship. It will group all alerts received via. push by their respective issue id. This will also perform the proper isForeground check to see if that issue is visible.
For Example (GCM) :- Inside your GCMIntentService

 @Override
 protected void onMessage(Context context, Intent intent) {
 if(intent.getExtras().getString("origin").equals("helpshift")) {
 Intent i = new Intent();
 i.setAction("HS_ON_MESSAGE");
 i.putExtras(intent);
 sendBroadcast(i);
 }
 }
 }

And inside your GCMIntentReceiver

 @Override
 public void onReceive(Context context, Intent intent) {
 String action = intent.getAction();
 if(action.equals("HS_ON_MESSAGE")) {
 Helpshift.handlePush(context, intent);
 }
 }

For Example (Urban Airship) :-

 @Override
 public void onReceive(Context context, Intent intent) {
 String action = intent.getAction();
 if (action.equals(PushManager.ACTION_PUSH_RECEIVED)) {
 if(intent.getExtras().getString("origin").equals("helpshift")) {
 Helpshift.handlePush(context, intent);
 }
 }
 }

Installs the Helpshift Android SDK in your app.

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

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);
 

 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.

Adds additonal debugging information in your code.

You can add additional debugging statements to your code, and see exactly what the user was doing right before they started a new conversation.

 Helpshift.leaveBreadCrumb("Went to Preferences Screen");

Login a user with a given identifier, name and email. This API introduces support for multiple login in Helpshift. The identifier uniquely identifies the user. Name and email are optional. If any Helpshift session is active, then any login attempt is ignored.

Logout a currently logged in user. After logout, Helpshift falls back to the default login. If any Helpshift session is active, then any logout attempt is ignored.

If you are using GCM push or Urban Airship and if you want to enable Push Notification in the Helpshift Android SDK, set the Android Push ID (APID) using this method, inside your IntentReceiver for Handling of Push Events. For Example (GCM) :-

 @Override
 public void onReceive(Context context, Intent intent) {
 String action = intent.getAction();
 

 if(action.equals("HS_ON_SEND")) {
 final String regId = GCMRegistrar.getRegistrationId(context);
 Helpshift.registerDeviceToken(context, regId);
 }
 }

For Example (Urban Airship) :-

 @Override
 public void onReceive(Context context, Intent intent) {
 String action = intent.getAction();
 if (action.equals(PushManager.ACTION_REGISTRATION_FINISHED)) {
 final String regId = PushManager.shared().getAPID();
 Helpshift.registerDeviceToken(context, regId);
 }
 }

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;
 }
 });
 

(Optional) You can specify the name and email for your User. If you want to reset both values, you should pass null for both params.

For example:

 Helpshift.setNameAndEmail("John", "john@example.com");

Set the SDK language for the given locale. Locale can contain two-letter lowercase ISO language codes (such as "en") as defined by ISO 639-1 and in addition contain two-letter uppercase ISO country codes (such as "US") as defined by ISO 3166-1. Language code and country code are separated by an underscore ("_"). Example - "pt_BR", "zh_CN".

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

 Helpshift.setSDKLanguage("fr");
 

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

 Helpshift.setSDKLanguage("zh_CN");
 

(Optional) If you already have indentification for your users, you can specify that as well.

For example:

 Helpshift.setUserIdentifier("user-id-100");

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>";
 HSAlertToRateAppListener actionListener =  new HSAlertToRateAppListener() {
 @Override
 public void onAction(Helpshift.HS_RATE_ALERT action) {
 String msg = "";
 switch (action) {
 case CLOSE:
 msg = "Close";
 break;
 case FEEDBACK:
 msg = "Feedback";
 break;
 case SUCCESS:
 msg = "Rate app";
 break;
 case 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 : false) When set to true; 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 (default), on resolution the Helpshift SDK will take the user directly to the "Start a new conversation" state.

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:-

 contactUsBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 Helpshift.showConversation(MyActivity.this);
 }
 });
 

Shows FAQ section activity.

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

 showFAQSectionBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 Helpshift.showFAQSection(MyActivity.this, "1");
 }
 });
 

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 : false) When set to true; 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 (default), 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 : false) When set to true; 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 (default), 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 faqs activity. This will show list of sections with search.

 showFaqsBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 Helpshift.showFAQs(MyActivity.this);
 }
 });
 

Shows question activity.

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

 showSingleFAQBtn.setOnClickListener(new OnClickListener() {
 @Override
 public void onClick(View view) {
 Helpshift.showSingleFAQ(MyActivity.this, "1");
 }
 });
 

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 : false) When set to true; 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 (default), on resolution the Helpshift SDK will take the user directly to the "Start a new conversation" state.