Looking for older SDK 3.X docs? Click here →

Upgrading from 5.x to 6.x

The Helpshift SDK v6.x is a major update and we have deprecated some APIs and removed the APIs deprecated in 5.x version of SDK. If you have questions or feedback, please contact us at support@helpshift.com

List of deleted APIs

Deleted API New API
[Helpshift installForApiKey:domainName:appID:(withOptions]] [HelpshiftCore installForApiKey:domainName:appID:(withConfig]]
[[Helpshift sharedInstance] showConversation:withOptions:] [HelpshiftSupport showConversation:withConfig:]
[[Helpshift sharedInstance] showFAQs:withOptions:] [HelpshiftSupport showFAQs:withConfig:]
[[Helpshift sharedInstance] showFAQSection:withController:withOptions:] [HelpshiftSupport showFAQSection:withController:withConfig:]
[[Helpshift sharedInstance] showSingleFAQ:withController:withOptions:] [HelpshiftSupport showSingleFAQ:withController:withConfig:]
[[Helpshift sharedInstance] registerDeviceToken:] [HelpshiftCore registerDeviceToken:]
[[Helpshift sharedInstance] handleRemoteNotification:withController:] [HelpshiftCore handleRemoteNotification:withController:]
[[Helpshift sharedInstance] setDelegate:] [[HelpshiftSupport sharedInstance] setDelegate:]
[Helpshift setName:andEmail:] [HelpshiftCore setName:andEmail:]
[Helpshift setUserIdentifier:] [HelpshiftSupport setUserIdentifier:]
[Helpshift loginWithIdentifier:withName:andEmail:] [HelpshiftCore loginWithIdentifier:withName:andEmail:]
[Helpshift logout] [HelpshiftCore logout];
[Helpshift setMetadataBlock:] [HelpshiftSupport setMetadataObjectBlock:]

List of deprecated APIs

Deprecated API New API
[HelpshiftCore installForApiKey:domainName:appID:(withOptions:)]] [HelpshiftCore installForApiKey:domainName:appID:(withConfig:)]]
[HelpshiftSupport showConversation:withOptions:]] [HelpshiftSupport showConversation:withConfig:]]
[HelpshiftSupport showFAQs:withOptions:]] [HelpshiftSupport showFAQs:withConfig:]]
[HelpshiftSupport showFAQSection:withController:withOptions:]] [HelpshiftSupport showFAQSection:withController:withConfig:]]
[HelpshiftSupport showSingleFAQ:withController:withOptions:]] [HelpshiftSupport showSingleFAQ:withController:withConfig:]]
[HelpshiftSupport setMetadataBlock:]] [HelpshiftSupport setMetadataObjectBlock:]]
[HelpshiftSupport showDynamicFormOnViewController:withTitle:andFlows:withConfigOptions:]] [HelpshiftSupport showDynamicFormOnViewController:withTitle:andFlows:withConfig:]]
[HelpshiftSupport flowToShowConversationWithDisplayText:andConfigOptions:]] [HelpshiftSupport flowToShowConversationWithDisplayText:andConfig:]]
[HelpshiftSupport flowToShowFAQsWithDisplayText:andConfigOptions:]] [HelpshiftSupport flowToShowFAQsWithDisplayText:andConfig:]]
[HelpshiftSupport flowToShowFAQSectionForPublishId:withDisplayText:andConfigOptions:]] [HelpshiftSupport flowToShowFAQSectionForPublishId:withDisplayText:andConfig:]]
[HelpshiftSupport flowToShowSingleFAQForPublishId:withDisplayText:andConfigOptions:]] [HelpshiftSupport flowToShowSingleFAQForPublishId:withDisplayText:andConfig:]]