Support

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

 Support.clearBreadCrumbs ();

You can use this API to get an embeddable SupportFragment with the provided config, which can be used in your Activity to show the conversations screen.

You can use this API to get an embeddable SupportFragment which can be used in your Activity to show the conversations screen.

This will return a Dynamic form embeddable "SupportFragment".

This will return a Dynamic form embeddable "SupportFragment". When using a standalone toolbar, provide the toolbar id inside the config map as "toolbarId".

You can use this API to get an embeddable SupportFragment with the provided config, which can be used in your Activity to show a FAQ section with the provided section publish id.

You can use this API to get an embeddable SupportFragment which can be used in your Activity to show a FAQ section with the provided section publish id.

You can use this API to get an embeddable SupportFragment with the provided config, which can be used in your Activity to show all FAQs.

You can use this API to get an embeddable SupportFragment which can be used in your Activity to show all FAQs.

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);
 }
 }
 };
 Support.getNotificationCount(countHandler, new Handler());

Gets notification count synchronously.

Ex:-

 Integer notifCount = Support.getNotificationCount();

You can use this API to get an embeddable SupportFragment with the provided config, which can be used in your Activity to show a Single FAQ with the provide question publish id.

You can use this API to get an embeddable SupportFragment which can be used in your Activity to show a Single FAQ with the provide question publish id.

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.

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

Set the session delegate for Support

Provide a function to fetch custom data.

 import com.helpshift.Callable;
 

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

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

 Support.setMetadataCallback (new Callable (){
 public HashMap call() {
 return k;
 }
 });
 

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.

 Support.setSDKLanguage("fr");
 

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

 Support.setSDKLanguage("zh_CN");
 

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

For example:

 Support.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>";
 AlertToRateAppListener actionListener =  new AlertToRateAppListener() {
 @Override
 public void onAction(Support.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();
 }
 };
 Support.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(Support.CustomMetadataKey, customMetadata);
 Support.showConversation(MyActivity.this, config);
 }
 });
 

Following flags are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Support SDK will land on conversation activity after starting a new conversation. If set to false Support SDK will land on last activity before starting a new conversation.
2. 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. 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. 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. 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. 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

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) {
 Support.showConversation(MyActivity.this);
 }
 });
 

This will show the Dynamic Form screen to facilitate Guided ticket filing.

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", Support.ENABLE_CONTACT_US.NEVER);
 config.put("requireEmail", true);
 config.put(Support.CustomMetadataKey, customMetadata);
 Support.showFAQSection(MyActivity.this, "1", config);
 }
 });
 

Following flags are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Support SDK will land on conversation activity after starting a new conversation. If set to false Support SDK will land on last activity before starting a new conversation.
2. enableContactUs (Default : Support.ENABLE_CONTACT_US.ALWAYS) The enableContactUs flag will determine whether the Contact Us button is shown. The default value is Support.ENABLE_CONTACT_US.ALWAYS.
3. 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. 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. 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. 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

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) {
 Support.showFAQSection(MyActivity.this, "1");
 }
 });
 

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

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

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", Support.ENABLE_CONTACT_US.ALWAYS);
 config.put("requireEmail", true);
 config.put(Support.CustomMetadataKey, customMetadata);
 Support.showFAQs(MyActivity.this, config);
 }
 });
 

Following flags are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Support SDK will land on conversation activity after starting a new conversation. If set to false Support SDK will land on last activity before starting a new conversation.
2. enableContactUs (Default : Support.ENABLE_CONTACT_US.ALWAYS) The enableContactUs flag will determine whether the Contact Us button is shown. The default value is Support.ENABLE_CONTACT_US.ALWAYS.
3. 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. 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. 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. 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

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", Support.ENABLE_CONTACT_US.NEVER);
 config.put("requireEmail", true);
 config.put(Support.CustomMetadataKey, customMetadata);
 Support.showSingleFAQ(MyActivity.this, "1", config);
 }
 });
 

Following flags are supported in this config -

1. gotoConversationAfterContactUs (Default : false) If set to true. Support SDK will land on conversation activity after starting a new conversation. If set to false Support SDK will land on last activity before starting a new conversation.
2. enableContactUs (Default : Support.ENABLE_CONTACT_US.ALWAYS) The enableContactUs flag will determine whether the Contact Us button is shown. The default value is Support.ENABLE_CONTACT_US.ALWAYS.
3. 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. 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. 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

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) {
 Support.showSingleFAQ(MyActivity.this, "1");
 }
 });