Helpshift Delegates

The Helpshift SDK provides delegate callbacks to help app developers track a user's activities within the help section.

All delegate callbacks will be sent as Unity-messages on the unityGameObject that you configure. If you want to connect to any of the below callbacks, please implement a public void method with a string as the only argument. This method needs to be implemented in the script which is attached to the unityGameObject configured via install.

Helpshift Session delegates

Session begin

helpshiftSessionBegan

If you want to keep track of when helpshift session starts in your app, you can implement this delegate callback. The delegate will get fired every time the Helpshift session starts.

Session end

helpshiftSessionEnded

If you want to keep track of when helpshift session ends in your app, you can implement this delegate callback. The delegate will get fired every time the Helpshift session ends.

New conversation delegate

newConversationStarted

If you want to keep track of when your app users start a new conversation through Helpshift, you can implement this delegate callback . The delegate will get fired every time the user starts a new conversation. The delegate method will receive the conversation message in it's arguments.

For example:

public void newConversationStarted (string newConversationMessage) {
  // your code here
}

As soon as an end user opens the conversation screen, they will see a greeting message, and the conversation is considered active.

Conversation ended delegate

This delegate receives a callback when an ongoing Conversation has ended. This delegate is called whenever the ongoing Conversation is resolved in the Dashboard, rejected, timed out or archived.

public void conversationEnded() {
// your code here
}

New message delegate

userRepliedToConversation

If you want to keep track of when your app users send new messages to an ongoing conversation, you can implement this delegate. This delegates will get called every time a user replies to a conversation. The delegate method will receive the new message's content in it's arguments. if the message is of a special type then it will be one of the following four messages.

public const String HSUserAcceptedTheSolution = "User accepted the solution";
public const String HSUserRejectedTheSolution = "User rejected the solution";
public const String HSUserSentScreenShot = "User sent a screenshot";
public const String HSUserReviewedTheApp = "User reviewed the app";

For example:

public void userRepliedToConversation (string newMessage) {
  if (newMessage.equals(HelpshiftSdk.HSUserAcceptedTheSolution)) {
    // your code here
  }
}

All replies from end users to your Bots (Answer Bot, Identity Bot) are also considered as new messages added by end users.

Customer satisfaction survey delegate

userCompletedCustomerSatisfactionSurvey

If you want to keep track of when your app user completes the customer satisfaction survey for a conversation, you can implement this delegate. This delegates will get called every time a user completes the customer satisfaction survey. The delegate method will receive the rating and the feedback in it's arguments.

For example:

public void userCompletedCustomerSatisfactionSurvey (string json) {
  // deserialize the json to get dictionary with rating and feedback keys
}

New message received count delegate

This delegate is the response to the requestUnreadMessagesCount method. It provides the number of unread messages in the current conversation. If isRemote set to true the unread message count is retrieved from server else unread message count for locally stored messages is returned.

Example usage:

public void didReceiveUnreadMessagesCount(string count) {
    // your code here
}

Conversation active delegate

This delegate responds to the checkIfConversationActive to get a boolean value that indicates whether there is an active Conversation open for the user. A Conversation is considered inactive when a user cannot respond with new messages on it.

Example usage:

public void didCheckIfConversationActive(string isActive) {
    if (isActive.Equals("true")) {
        //Active Conversation
    } else {
        //No open Conversation
    }
}

Display attachment delegate

Agents can attach a wide variety of files when replying to users. This delegate is called when the user taps on downloaded attachment file to view it. If the app chooses to display the attachment file itself, you can implement this delegate. If the app does not wish to handle the attachment, and this delegate is not implemented , in this case, the SDK will display the attachment using Quicklook Framework.

Example usage:

private HelpshiftSdk help;

help = HelpshiftSdk.getInstance();
// If you want that all files with extension token should be handled by your app.
Dictionary<string, object> configMap = new Dictionary<string, object>();
configMap.Add("supportedFileFormats",new string [] {"token"});
help.install("<API_KEY>", "<DOMAIN_NAME>", "<APP_ID>",configMap);
public void displayAttachmentFile (string path) {
    // your code here
}