The Helpshift SDK v3.x is a major update and we have deprecated some APIs. If you have questions or feedback, please Contact Us
Please replace all the old files with new files.
Deprecated API | New API |
---|---|
HelpshiftCore#SetNameAndEmail(string name, string email) | HelpshiftCore#Login(HelpshiftUser user) |
HelpshiftSupport#SetUserIdentifier(string userIdentifier) | HelpshiftCore#Login(HelpshiftUser user) |
HelpshiftCore#Login(String userId, String name, String email) | HelpshiftCore#Login(HelpshiftUser user) |
HelpshiftCore.Install(string apiKey, string domainName, string appId, Dictionary |
HelpshiftCore.Install(string apiKey, string domainName, string appId, HelpshiftInstallConfig config) |
HelpshiftSupport.ShowFAQs(Object uiParent, Dictionary |
HelpshiftSupport.ShowFAQs(Object uiParent, HelpshiftAPIConfig config) |
HelpshiftSupport.ShowFAQSection(string sectionId, Object uiParent, Dictionary |
HelpshiftSupport.ShowFAQSection(string sectionId, Object uiParent, HelpshiftAPIConfig config) |
HelpshiftSupport.ShowConversation(Object uiParent, Dictionary |
HelpshiftSupport.ShowConversation(Object uiParent, HelpshiftAPIConfig config) |
HelpshiftSupport.ShowSingleFAQ(string faqId, Object uiParent, Dictionary |
HelpshiftSupport.ShowSingleFAQ(string faqId, Object uiParent, HelpshiftAPIConfig config) |
HelpshiftSupport.GetNotificationCount(bool isAsync) | HelpshiftSupport.RequestUnreadMessagesCount(bool isRemote) |
HelpshiftSupport.SetSDKLanguage(string locale) | HelpshiftCore.SetLanguage(string languageCode) |
HelpshiftSupport.ShowDynamicForm(Object uiParent, string title, Dictionary |
HelpshiftSupport.ShowDynamicForm(Object uiParent, string title, IList |
HelpshiftSupport.IsConversationActive() | HelpshiftSupport.CheckIfConversationActive() |
HelpshiftCampaigns.ShowInbox(Object uiParent, Dictionary |
HelpshiftCampaigns.ShowInbox(Object uiParent, HelpshiftAPIConfig config) |
Removed API | New API |
---|---|
InternalHsApiDefinition.IHelpshiftInboxMessage | InboxMessage |
HelpshiftInbox.SetInboxMessageDelegate(InternalHsApiDefinition.HelpshiftInboxDelegate delegate) | HelpshiftInbox.SetInboxMessageDelegate(IInboxMessageDelegate delegate); |
HelpshiftCampaigns.SetInboxMessageDelegate(InternalHsApiDefinition.HelpshiftInboxDelegate delegate) | HelpshiftCampaigns.SetInboxMessageDelegate(IInboxMessageDelegate delegate); |
HelpshiftInbox.SetInboxNotificationDelegate(InternalHsApiDefinition.HelpshiftInboxNotificationDelegate delegate); | HelpshiftInbox.SetInboxNotificationDelegate(IInboxNotificationDelegate delegate); |
HelpshiftCampaigns.SetCampaignsDelegate(InternalHsApiDefinition.HelpshiftCampaignsDelegate); | HelpshiftCampaigns.SetCampaignsDelegate(ICampaignsDelegate delegate); |
HelpshiftSupport.SetDelegate(InternalHsApiDefinition.HelpshiftSupportDelegate delegate); | HelpshiftSupport.SetDelegate(ISupportDelegate delegate); |
You can login your users using the new Login API.
It is expected that you will pass the user's name, email using the Login API.
It is expected that you will pass the user identifier using the Login API.