Helpshift

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.

 hs.clearBreadCrumbs ();

Clears user data. Deletes following keys from database 'identity', 'issuesIdList' and all issues. This does not clear config data or faqs.

Gets notification count synchronously. Ex:-

 Integer notifCount = hs.getNotificationCount();

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

         }
     };

Provides a PendingIntent, when generating Notifications for GCM push. For Example:-

 private void generateNotification(Context context, Intent i) {
    hs = new Helpshift(context);

    if(intent.getExtras().getString("origin").equals("helpshift")) {
          PendingIntent intent = hs.getPendingIntentOnPush(context, i);
    }

    int icon = R.drawable.notif_icon;
    Bundle extras = i.getExtras();
    String message = extras.getString("alert");
    long when = System.currentTimeMillis();

    Notification notification = new Notification(icon, message, when);
    String title = context.getString(R.string.app_name);
    notification.setLatestEventInfo(context, title, message, intent);
    notification.flags |= Notification.FLAG_AUTO_CANCEL;

    NotificationManager notificationManager = (NotificationManager)
       context.getSystemService(Context.NOTIFICATION_SERVICE);
    notificationManager.notify(0, notification);
 }

Installs the Helpshift Android SDK in your app.

 hs.install(this,
            "<YOUR_API_KEY>",
            "<yourcompany>.helpshift.com",
            "<YOUR_APP_ID>");

This is used to find out if the Helpshift issues chat screen is in the foreground. Can be used to conditionally show/disable notifications when chat is shown. This can be done by implementing your own PushNotificationBuilder. For Example:-

 public Notification buildNotification(String alert, Map extras) {
     Context c = UAirship.shared().getApplicationContext();

     if(!hs.isForeground()) {
         return super.buildNotification(alert, extras);
     } else {
         return null;
     }
 }

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 reported the issue.

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

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

 hs.setDeviceIdentifier("user-id-100");

If you are using 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:-

 String action = intent.getAction();
 if (action.equals(PushManager.ACTION_REGISTRATION_FINISHED)) {
     hs.setDeviceToken(PushManager.shared().getAPID());
 }

(Optional) you can configure or pre-define certain user information. Provided you have that information, so that the user does not have to provide their information again. For example:

 hs.setEmail("john@helpshift.com");

(Optional) you can configure or pre-define certain user information. Provided you have that information, so that the user does not have to provide their information again. For example:

 hs.setUsername("John");

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

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

Shows issues inbox activity. This will render a view with list of issues. For example, this can be triggered on the onClick of inboxBtn Button

 inboxBtn.setOnClickListener(new OnClickListener() {
         @Override
         public void onClick(View view) {
             hs.showInbox(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 showQuestionBtn Button.

 showQuestionBtn.setOnClickListener(new OnClickListener() {
         @Override
         public void onClick(View view) {
             hs.showQuestion(MyActivity.this, "1");
         }
     });
 

Shows report issue activity. This provides a direct call to the "Report new issue" activity. For example, this can be triggered on the onClick of "Report Issue" Button

 reportIssueBtn.setOnClickListener(new OnClickListener() {
         @Override
         public void onClick(View view) {
             hs.showReportIssue(MyActivity.this);
         }
     });
 

Shows section activity. This will show a 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 showSectionBtn Button

 showSectionBtn.setOnClickListener(new OnClickListener() {
         @Override
         public void onClick(View view) {
             hs.showSection(MyActivity.this, "1");
         }
     });
 

Calls the main support screen. For example, this can be triggered on the onClick of a "Help" button.

 helpBtn.setOnClickListener(new OnClickListener() {
         @Override
         public void onClick(View view) {
             hs.showSupport(MyActivity.this);
         }
     });

To show Helpshift support on Notification opened, call showSupportOnPush in your IntentReceiver for Handling of Push Events. Check that the origin is "helpshift" before calling showSupportOnPush. For Example:-

 String action = intent.getAction();
 if (action.equals(PushManager.ACTION_NOTIFICATION_OPENED)) {
     if(intent.getExtras().getString("origin").equals("helpshift")) {
         hs.showSupportOnPush(intent);
     }
 }

Starts poller for fetching notification count asynchronously by implementing the countHandler and failHandler. Polling interval needs to be specified in seconds. The minimum you can specify is 3 seconds.

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

         }
     };

   @Override
 public void onResume() {
     super.onResume();
     hs.startNotifCountPolling(countHandler, failHandler, 3);
 }

Starts poller for fetching notification count asynchronously by implementing the countHandler and failHandler. The polling interval is 10 seconds. 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);
             }

         }
     };

 @Override
 public void onResume() {
     super.onResume();
     hs.startNotifCountPolling(countHandler, failHandler);
 }

Stops poller for fetching notification count.

 @Override
 public void onPause() {
     super.onPause();
     hs.stopNotifCountPolling();
 }