HelpshiftSupport Class Reference

Inherits from NSObject
Conforms to HsApiProvider
Declared in HelpshiftSupport.h

Overview

This document describes the API exposed by the Helpshift SDK (4.x) which the developers can use to integrate Helpshift support into their iOS applications. If you want documentation regarding how to use the various features provided by the Helpshift SDK, please visit the developer docs

+ sharedInstance

Returns an instance of Helpshift

+ (HelpshiftSupport *)sharedInstance

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

Declared In

HelpshiftSupport.h

+ pauseDisplayOfInAppNotification:

To pause and restart the display of inapp notification

+ (void)pauseDisplayOfInAppNotification:(BOOL)pauseInApp

Parameters

pauseInApp

the boolean value to pause/restart inapp nofitications

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.

Declared In

HelpshiftSupport.h

+ setSDKLanguage:

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. (Deprecated: Deprecated in SDK version 6.1.0.)

+ (BOOL)setSDKLanguage:(NSString *)languageCode

Parameters

languageCode

the string representing the language code. For example, use ‘fr’ for French.

Return Value

BOOL indicating wether the specified language was applied. In case the language code is incorrect or the corresponding localization file was not found, bool value of false is returned and the default language is used.

Availability

Available in SDK version 5.0.0 or later.

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.

Declared In

HelpshiftSupport.h

+ setLanguage:

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

+ (void)setLanguage:(NSString *)languageCode

Parameters

languageCode

the string representing the language code. For example, use ‘fr’ for French.

Availability

Available in SDK version 6.1.0 or later

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

Declared In

HelpshiftSupport.h

+ showConversation:withOptions:

Show the helpshift conversation screen (with Optional Arguments)

+ (void)showConversation:(UIViewController *)viewController withOptions:(NSDictionary *)optionsDictionary

Parameters

viewController

viewController on which the helpshift report issue screen will show up.

optionsDictionary

the dictionary which will contain the arguments passed to the Helpshift conversation session (that will start with this method call).

Please check the docs for available options.

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ showConversation:withConfig:

Show the helpshift conversation screen (with Optional Arguments)

+ (void)showConversation:(UIViewController *)viewController withConfig:(HelpshiftAPIConfig *)configObject

Parameters

viewController

viewController on which the helpshift report issue screen will show up.

configObject

an API config object which will contain the arguments passed to the Helpshift conversation session (that will start with this method call).

Please check the docs for available options.

Availability

Available in SDK version 5.7.0 or later

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.

Declared In

HelpshiftSupport.h

+ showFAQs:withOptions:

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

+ (void)showFAQs:(UIViewController *)viewController withOptions:(NSDictionary *)optionsDictionary

Parameters

viewController

viewController on which the helpshift faqs screen will show up.

optionsDictionary

the dictionary which will contain the arguments passed to the Helpshift faqs screen session (that will start with this method call).

Please check the docs for available options.

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ showFAQs:withConfig:

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

+ (void)showFAQs:(UIViewController *)viewController withConfig:(HelpshiftAPIConfig *)configObject

Parameters

viewController

viewController on which the helpshift faqs screen will show up.

configObject

an API config object which will contain the arguments passed to the Helpshift faqs screen session (that will start with this method call).

Please check the docs for available options.

Availability

Available in SDK version 5.7.0 or later

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.

Declared In

HelpshiftSupport.h

+ showFAQSection:withController:withOptions:

Show the helpshift screen with faqs from a particular section

+ (void)showFAQSection:(NSString *)faqSectionPublishID withController:(UIViewController *)viewController withOptions:(NSDictionary *)optionsDictionary

Parameters

faqSectionPublishID

the publish id associated with the faq section which is shown in the FAQ page on the admin side (yourcompanyname.helpshift.com/admin/faq/).

viewController

viewController on which the helpshift faq section screen will show up.

optionsDictionary

the dictionary which will contain the arguments passed to the Helpshift session (that will start with this method call).

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ showFAQSection:withController:withConfig:

Show the helpshift screen with faqs from a particular section

+ (void)showFAQSection:(NSString *)faqSectionPublishID withController:(UIViewController *)viewController withConfig:(HelpshiftAPIConfig *)configObject

Parameters

faqSectionPublishID

the publish id associated with the faq section which is shown in the FAQ page on the admin side (yourcompanyname.helpshift.com/admin/faq/).

viewController

viewController on which the helpshift faq section screen will show up.

configObject

an API config object which will contain the arguments passed to the Helpshift session (that will start with this method call).

Availability

Available in SDK version 5.7.0 or later

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.

Declared In

HelpshiftSupport.h

+ showSingleFAQ:withController:withOptions:

Show the helpshift screen with a single faq

+ (void)showSingleFAQ:(NSString *)faqPublishID withController:(UIViewController *)viewController withOptions:(NSDictionary *)optionsDictionary

Parameters

faqPublishID

the publish id associated with the faq which is shown when you expand a single FAQ (yourcompanyname.helpshift.com/admin/faq/)

viewController

viewController on which the helpshift faq section screen will show up.

optionsDictionary

the dictionary which will contain the arguments passed to the Helpshift session (that will start with this method call).

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ showSingleFAQ:withController:withConfig:

Show the helpshift screen with a single faq

+ (void)showSingleFAQ:(NSString *)faqPublishID withController:(UIViewController *)viewController withConfig:(HelpshiftAPIConfig *)configObject

Parameters

faqPublishID

the publish id associated with the faq which is shown when you expand a single FAQ (yourcompanyname.helpshift.com/admin/faq/)

viewController

viewController on which the helpshift faq section screen will show up.

configObject

an API config object which will contain the arguments passed to the Helpshift session (that will start with this method call).

Availability

Available in SDK version 5.7.0 or later

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.

Declared In

HelpshiftSupport.h

+ showAlertToRateAppWithURL:withCompletionBlock:

Show alert for app rating (Deprecated: Deprecated in SDK version 6.2.0)

+ (void)showAlertToRateAppWithURL:(NSString *)url withCompletionBlock:(HelpshiftSupportAppRatingAlertViewCompletionBlock)completionBlock

Parameters

url

Application’s link in iTunes store.

completionBlock

Completion action block with action taken by the user in response to app rating prompt.

Availability

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ setUserIdentifier:

Set an user identifier for your users.

+ (void)setUserIdentifier:(NSString *)userIdentifier

Parameters

userIdentifier

A string to identify your users.

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ leaveBreadCrumb:

Add extra debug information regarding user-actions.

+ (void)leaveBreadCrumb:(NSString *)breadCrumbString

Parameters

breadCrumbString

The string containing any relevant debugging information.

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ setMetadataBlock:

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

+ (void)setMetadataBlock:(HelpshiftSupportMetadataBlock)metadataBlock

Parameters

metadataBlock

a block variable which accepts zero arguments and returns an NSDictionary.

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ setMetadataObjectBlock:

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

+ (void)setMetadataObjectBlock:(HelpshiftSupportMetadataObjectBlock)metadataBlock

Parameters

metadataBlock

a block variable which accepts zero arguments and returns an HelpshiftSupportMetadataObject.

Availability

Available in SDK version 5.7.0 or later

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.

Declared In

HelpshiftSupport.h

+ isConversationActive

Get a boolean value that indicates if there is any active converation in the SDK currently. (Deprecated: Deprecated in SDK version 6.1.0)

+ (BOOL)isConversationActive

Return Value

Returns YES if there an active conversation going on otherwise returns NO.

Availability

Available in SDK version 5.10.0 or later

Discussion

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

Declared In

HelpshiftSupport.h

+ checkIfConversationActive

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

+ (void)checkIfConversationActive

Availability

Available in SDK version 6.1.0 or later

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

Declared In

HelpshiftSupport.h

+ getNotificationCountFromRemote:

Get the notification count for replies to new conversations. (Deprecated: Deprecated in SDK version 6.1.0)

+ (NSInteger)getNotificationCountFromRemote:(BOOL)isRemote

Parameters

isRemote

Whether the notification count is to be returned asynchronously via delegate mechanism or synchronously as a return val for this api

Availability

Available in SDK version 5.0.0 or later

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.

Declared In

HelpshiftSupport.h

+ requestUnreadMessagesCount:

Get the notification count for replies to new conversations.

+ (void)requestUnreadMessagesCount:(BOOL)isRemote

Parameters

isRemote

get the count from network or from the local DB

Availability

Available in SDK version 6.1.0 or later

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.

Declared In

HelpshiftSupport.h

+ clearBreadCrumbs

Clears Breadcrumbs list.

+ (void)clearBreadCrumbs

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

Declared In

HelpshiftSupport.h

+ closeHelpshiftSupportSession

Close the current Helpshift session

+ (void)closeHelpshiftSupportSession

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

Declared In

HelpshiftSupport.h

+ handleContinueUserActivity:withController:andRestorationHandler:

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.

+ (BOOL)handleContinueUserActivity:(NSUserActivity *)userActivity withController:(UIViewController *)viewController andRestorationHandler:(void ( ^ ) ( NSArray *))restorationHandler

Parameters

userActivity

useractivity object receieved in the delegate callback

viewController

view controller on which Helpshift should show the FAQ detail screen.

restorationHandler

restoration handler received in the delegate callback

Return Value

returns YES if Helpshift has handled the event, NO otherwise.

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.

Declared In

HelpshiftSupport.h

+ addLog:

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.

+ (void)addLog:(NSString *)message

Parameters

message

The string to be logged.

Available in SDK version 6.3.0 or later

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.

Declared In

HelpshiftSupport.h

+ showDynamicFormOnViewController:withTitle:andFlows:withConfigOptions:

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). (Deprecated: Depricated in 6.1.0.)

+ (BOOL)showDynamicFormOnViewController:(UIViewController *)viewController withTitle:(NSString *)title andFlows:(NSArray *)flows withConfigOptions:(NSDictionary *)configOptions

Parameters

viewController

The view controller on which Dynamic form will be presented.

title

The title of the form.

flows

A list of ‘HsFlow’ objects.

configOptions

Config option that applies to Dynamic form itself (NOTE: this is not automatically applied to the flows). Currently the only config option applicable her is ‘presentFullScreenOniPad’ which can be ‘yes’ or ‘no’

Return Value

Returns YES if the data provided was valid to create a dynamic form, otherwise returns NO.

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

Declared In

HelpshiftSupport.h

+ showDynamicFormOnViewController:withTitle:andFlows:withConfig:

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

+ (BOOL)showDynamicFormOnViewController:(UIViewController *)viewController withTitle:(NSString *)title andFlows:(NSArray *)flows withConfig:(HelpshiftAPIConfig *)configObject

Parameters

viewController

The view controller on which Dynamic form will be presented.

title

The title of the form.

flows

A list of ‘HsFlow’ objects.

configObject

API config object that applies to Dynamic form itself (NOTE: this is not automatically applied to the flows). Currently the only config option applicable her is ‘presentFullScreenOniPad’ which can be ‘yes’ or ‘no’

Return Value

Returns YES if the data provided was valid to create a dynamic form, otherwise returns NO.

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

Declared In

HelpshiftSupport.h

+ showDynamicFormOnViewController:withTitle:andFlowsData:withConfigOptions:

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

+ (BOOL)showDynamicFormOnViewController:(UIViewController *)viewController withTitle:(NSString *)title andFlowsData:(NSArray *)flows withConfigOptions:(NSDictionary *)configOptions

Parameters

viewController

The view controller on which Dynamic form will be presented.

title

The title of the form.

flows

A list of NSDictionary objects. Following are the key/value pairs required in the dictionary 1. “type” - this key should contain the type of flow. value should be one of the following : 1. Support.FAQS_FLOW 2. Support.CONVERSATION_FLOW 3. Support.FAQ_SECTION_FLOW 4. Support.SINGLE_FAQ_FLOW 2. “title” - resource name of the title shown for the flow 3. “data” - data required for the flow. its value should be as described below : for FAQ_SECTION_FLOW, “data” should contain string section id for SINGLE_FAQ_FLOW, “data” shoudl contain string faq id for FAQsFlow and ConversationFlow, no “data” is required 4. “config” - it should be a HashMap which is used to pass as config to Support APIs. for DYNAMIC_FORM_FLOW, no “config” is required

configOptions

Config option that applies to Dynamic form itself (NOTE: this is not automatically applied to the flows). Currently the only config option applicable her is ‘presentFullScreenOniPad’ which can be ‘yes’ or ‘no’

Return Value

Returns YES if the data provided was valid to create a dynamic form, otherwise returns NO.

Discussion

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

Declared In

HelpshiftSupport.h

+ pushDynamicFormOnViewController:withTitle:andFlows:

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

+ (BOOL)pushDynamicFormOnViewController:(UIViewController *)viewController withTitle:(NSString *)title andFlows:(NSArray *)flows

Parameters

viewController

The view controller on which Dynamic form will be pushed.

title

The title of the form.

flows

A list of ‘HsFlow’ objects.

Return Value

Returns YES if the data provided was valid to create a dynamic form, otherwise returns NO.

Discussion

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

Declared In

HelpshiftSupport.h

+ dynamicFormWithTitle:andFlows:

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 (Deprecated: Deprecated in SDK version 6.1.0)

+ (UINavigationController *)dynamicFormWithTitle:(NSString *)title andFlows:(NSArray *)flows

Parameters

title

The title of the form.

flows

A list of ‘HsFlow’ objects.

Return Value

Returns a UINavigationController if the data provided was valid to create a dynamic form, otherwise returns nil.

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

Declared In

HelpshiftSupport.h

+ requestDynamicFormWithTitle:andFlows:

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

+ (void)requestDynamicFormWithTitle:(NSString *)title andFlows:(NSArray *)flows

Parameters

title

The title of the form.

flows

A list of ‘HsFlow’ objects.

Availability

Available in SDK version 6.1.0 or later

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

Declared In

HelpshiftSupport.h

+ flowToShowConversationWithDisplayText:andConfigOptions:

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

+ (id)flowToShowConversationWithDisplayText:(NSString *)displayText andConfigOptions:(NSDictionary *)configOptions

Parameters

displayText

Text to be displayed in the row.

configOptions

The config options to be passed to showConversation: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowConversationWithDisplayText:andConfig:

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

+ (id)flowToShowConversationWithDisplayText:(NSString *)displayText andConfig:(HelpshiftAPIConfig *)configObject

Parameters

displayText

Text to be displayed in the row.

configObject

The API config object to be passed to showConversation: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowFAQsWithDisplayText:andConfigOptions:

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

+ (id)flowToShowFAQsWithDisplayText:(NSString *)displayText andConfigOptions:(NSDictionary *)configOptions

Parameters

displayText

Text to be displayed in the row.

configOptions

The config options to be passed to showFAQSection: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowFAQsWithDisplayText:andConfig:

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

+ (id)flowToShowFAQsWithDisplayText:(NSString *)displayText andConfig:(HelpshiftAPIConfig *)configObject

Parameters

displayText

Text to be displayed in the row.

configObject

The API config object to be passed to showFAQSection: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowFAQSectionForPublishId:withDisplayText:andConfigOptions:

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

+ (id)flowToShowFAQSectionForPublishId:(NSString *)sectionPublishId withDisplayText:(NSString *)displayText andConfigOptions:(NSDictionary *)configOptions

Parameters

sectionPublishId

The Publish-Id of the FAQ section.

displayText

Text to be displayed in the row.

configOptions

The config options to be passed to showFAQSection: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowFAQSectionForPublishId:withDisplayText:andConfig:

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

+ (id)flowToShowFAQSectionForPublishId:(NSString *)sectionPublishId withDisplayText:(NSString *)displayText andConfig:(HelpshiftAPIConfig *)configObject

Parameters

sectionPublishId

The Publish-Id of the FAQ section.

displayText

Text to be displayed in the row.

configObject

The config API object to be passed to showFAQSection: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowSingleFAQForPublishId:withDisplayText:andConfigOptions:

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

+ (id)flowToShowSingleFAQForPublishId:(NSString *)FAQPublishId withDisplayText:(NSString *)displayText andConfigOptions:(NSDictionary *)configOptions

Parameters

FAQPublishId

The Publish-Id of the FAQ.

displayText

Text to be displayed in the row.

configOptions

The config options to be passed to showSingleFAQ: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowSingleFAQForPublishId:withDisplayText:andConfig:

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

+ (id)flowToShowSingleFAQForPublishId:(NSString *)FAQPublishId withDisplayText:(NSString *)displayText andConfig:(HelpshiftAPIConfig *)configObject

Parameters

FAQPublishId

The Publish-Id of the FAQ.

displayText

Text to be displayed in the row.

configObject

The config options to be passed to showSingleFAQ: method.

Return Value

a flow object to be used for creating a dynamic form.

Discussion

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

Declared In

HelpshiftSupport.h

+ flowToShowNestedDynamicFormWithFlows:withDisplayText:

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

+ (id)flowToShowNestedDynamicFormWithFlows:(NSArray *)nextDynamicFormFlows withDisplayText:(NSString *)displayText

Parameters

nextDynamicFormFlows

A list of ‘flow’ objects that will show up as the next dynamic form when this flow is tapped.

displayText

Text to be displayed in the row.

Return Value

a flow object to be used for creating a dynamic form.

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

Declared In

HelpshiftSupport.h

+ flowToPerformCustomActionOnTarget:andSelector:withOptionalObject:withDisplayText:

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

+ (id)flowToPerformCustomActionOnTarget:(id)target andSelector:(SEL)selector withOptionalObject:(id)optionalObject withDisplayText:(NSString *)displayText

Parameters

target

The target on which the selector will be called.

selector

The selector that needs to be invoked.

optionalObject

An optional object that needs to be passed to the selector.

displayText

Text to be displayed in the row.

Return Value

a flow object.

Discussion

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

Declared In

HelpshiftSupport.h

+ log:

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. (Deprecated: Deprecated in SDK version 6.3.0.)

+ (void)log:(NSString *)format, ...

Parameters

format

The format string to be logged.

...

Variable arguments list.

Available in SDK version 5.9.0 or later

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.

Declared In

HelpshiftSupport.h