Discussion

Returns an instance of Helpshift

When using HelphisftSupport, use below method to get the singleton instance of this class.

Available in SDK version 5.0.0 or later

Discussion

To pause and restart the display of inapp notification

When this method is called with boolean value YES, inapp notifications are paused and not displayed. To restart displaying inapp notifications pass the boolean value NO.

Discussion

Change the SDK language. By default, the device’s prefered language is used. If a Helpshift session is already active at the time of invocation, this call will fail and will return false.

Discussion

Change the SDK language. By default, the device’s prefered language is used. The call will fail in the following cases : 1. If a Helpshift session is already active at the time of invocation 2. Language code is incorrect 3. Corresponding localization file is not found

Discussion

Show the helpshift conversation screen (with Optional Arguments)

To show the Helpshift conversation screen with optional arguments you will need to pass the name of the viewcontroller on which the conversation screen will show up and an options dictionary. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show the helpshift conversation screen (with Optional Arguments)

To show the Helpshift conversation screen with optional arguments you will need to pass the name of the viewcontroller on which the conversation screen will show up and an API config object. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show the support screen with only the faqs (with Optional Arguments)

To show the Helpshift screen with only the faq sections with search with optional arguments, you can use this api. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show the support screen with only the faqs (with Optional Arguments)

To show the Helpshift screen with only the faq sections with search with optional arguments, you can use this api. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show the helpshift screen with faqs from a particular section

To show the Helpshift screen for showing a particular faq section you need to pass the publish-id of the faq section and the name of the viewcontroller on which the faq section screen will show up. For example from inside a viewcontroller you can call the Helpshift faq section screen by passing the argument “self” for the viewController parameter. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show the helpshift screen with faqs from a particular section

To show the Helpshift screen for showing a particular faq section you need to pass the publish-id of the faq section and the name of the viewcontroller on which the faq section screen will show up. For example from inside a viewcontroller you can call the Helpshift faq section screen by passing the argument “self” for the viewController parameter. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show the helpshift screen with a single faq

To show the Helpshift screen for showing a single faq you need to pass the publish-id of the faq and the name of the viewcontroller on which the faq screen will show up. For example from inside a viewcontroller you can call the Helpshift faq section screen by passing the argument “self” for the viewController parameter. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show the helpshift screen with a single faq

To show the Helpshift screen for showing a single faq you need to pass the publish-id of the faq and the name of the viewcontroller on which the faq screen will show up. For example from inside a viewcontroller you can call the Helpshift faq section screen by passing the argument “self” for the viewController parameter. If you do not want to pass any options then just pass nil which will take on the default options.

Discussion

Show alert for app rating

To manually show an alert for app rating, you need automated reviews disabled in admin. Also, if there is an ongoing conversation, the review alert will not show up.

Discussion

Set an user identifier for your users.

This is part of additional user configuration. The user identifier will be passed through to the admin dashboard as “User ID” under customer info.

Discussion

Add extra debug information regarding user-actions.

You can add additional debugging statements to your code, and see exactly what the user was doing right before they reported the issue.

Discussion

Provide a block which returns a dictionary for custom meta data to be attached along with new conversations

If you want to attach custom data along with any new conversation, use this api to provide a block which accepts zero arguments and returns an NSDictionary containing the meta data key-value pairs. Everytime an issue is reported, the SDK will call this block and attach the returned meta data dictionary along with the reported issue. Ideally this metaDataBlock should be provided before the user can file an issue.

Discussion

Provide a block which returns a HelpshiftSupportMetadataObject for custom meta data to be attached along with new conversations

If you want to attach custom data along with any new conversation, use this api to provide a block which accepts zero arguments and returns an HelpshiftSupportMetadataObject containing the meta data dictionary. Everytime an issue is reported, the SDK will call this block and attach the returned HelpshiftSupportMetadataObject along with the reported issue. Ideally this metaDataBlock should be provided before the user can file an issue.

Discussion

Get a boolean value that indicates if there is any active converation in the SDK currently.

Discussion

Check if there is any active conversation going on in the SDK. This is an asynchronous call whose result will be provided in the callback defined in HelpshiftSupportDelegate: @code -(void) didCheckIfConversationActive:(BOOL)isActive; @endcode

Discussion

Get the notification count for replies to new conversations.

If you want to show your user notifications for replies on any ongoing conversation, you can get the notification count asynchronously by implementing the HelpshiftSupportDelegate in your respective .h and .m files.

Discussion

Get the notification count for replies to new conversations.

If you want to show your user notifications for replies on any ongoing conversation, you can get the notification count asynchronously by implementing the HelpshiftSupportDelegate in your respective .h and .m files. Now you can call the method [HelpshiftSupport requestUnreadMessagesCount:YES]; This will return a notification count in the - (void) didReceiveUnreadMessagesCount:(NSInteger)count count delegate method.

Discussion

Clears Breadcrumbs list.

Breadcrumbs list stores upto 100 latest actions. You’ll receive those in every Issue. If for some reason you want to clear previous messages, you can use this method.

Available in SDK version 5.0.0 or later

Discussion

Close the current Helpshift session

If currently any Helpshift session is active, this API will close that session. Otherwise if any Helpshift session is not active, this API does nothing.

Available in SDK version 5.0.0 or later

Discussion

Let the Helpshift SDK handle the continue user activity delegate. This method should be called from the application’s handleContinueUserActivity delegate. Currently this method is required for the FAQ integration with CoreSpotlight search to work correctly.

Discussion

This is a wrapper over NSLog. Use this API as a replacement over NSLog for the logs that need to be added as meta data while filing an issue. This API internally calls NSLog.

Discussion

Use this method to create a list of custom ‘flows’ and present them in tabular form to the user. A flow consists of 1) The text to be displayed (like ‘I think a player is cheating’) and 2) The action to be invoked for this option (like ‘showConversation:’). In this case besides calling the showConversation: method, Helpshfit will also add a tag (‘I think a player is cheating’, or any other custom tag) to the filed issue. These tags can later be used by you to gain insight as to how users are using your support. Actions supported by Dynamic forms: showConversation:, showFAQs:, showSingleFAQ:, showFAQSection: and showNextDynamicForm: (for nesting forms).

Discussion

Use this method to create a list of custom ‘flows’ and present them in tabular form to the user. A flow consists of 1) The text to be displayed (like ‘I think a player is cheating’) and 2) The action to be invoked for this option (like ‘showConversation:’). In this case besides calling the showConversation: method, Helpshfit will also add a tag (‘I think a player is cheating’, or any other custom tag) to the filed issue. These tags can later be used by you to gain insight as to how users are using your support. Actions supported by Dynamic forms: showConversation:, showFAQs:, showSingleFAQ:, showFAQSection: and showNextDynamicForm: (for nesting forms).

Discussion

Use this method to show a Dynamic form built from an NSDictionary.

Discussion

This is the push variant of showDynamicFormOnViewController: Use this method if you want to push the dynamic form to your navigation stack.

Discussion

Creates and returns the a Dynamic Form navigation controller. This is a variant of showDynamicFormOnViewController: Use this variant if you want to embed dynamic form in a UITabBarController

Discussion

Requests a Dynamic Form navigation controller to be returned in [HelpshiftSupportDelegate didCreateDynamicForm:] delegate callback. This is a variant of showDynamicFormOnViewController: Use this variant if you want to embed dynamic form in a UITabBarController

Discussion

Create a flow object which launches the conversation view when tapped. Refer to showConversation: for more details.

Discussion

Create a flow object which launches the conversation view when tapped. Refer to showConversation: for more details.

Discussion

Create a flow object which shows all the FAQs when tapped. Refer to showFAQs: for more details.

Discussion

Create a flow object which shows all the FAQs when tapped. Refer to showFAQs: for more details.

Discussion

Create a flow object which launches a FAQ section when tapped. Refer to showFAQSection: for more details.

Discussion

Create a flow object which launches a FAQ section when tapped. Refer to showFAQSection: for more details.

Discussion

Create a flow object which launches a single FAQ when tapped. Refer to showSingleFAQ: for more details.

Discussion

Create a flow object which launches a single FAQ when tapped. Refer to showSingleFAQ: for more details.

Discussion

Use this method to nest a dynamic form within another dynamic form. Basically this method takes a list of ‘flows’ and combines them into a single ‘flow’ (the next dynamic form).

Discussion

Use this method to create a flow that performs a custom action when tapped.

Discussion

This is a wrapper over NSLog. Use this API as a replacement over NSLog for the logs that need to be added as meta data while filing an issue. This API internally calls NSLog.