HelpshiftSupportDelegate Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | HelpshiftSupport.h |
– didReceiveUnreadMessagesCount:
required method
Delegate method call that should be implemented if you are calling requestUnreadMessagesCount:
- (void)didReceiveUnreadMessagesCount:(NSInteger)count
Parameters
count |
Returns the number of unread messages for the ongoing conversation Available in SDK version 6.1.0 or later |
---|
Discussion
Delegate method call that should be implemented if you are calling requestUnreadMessagesCount:
Declared In
HelpshiftSupport.h
– didReceiveNotificationCount:
Optional delegate method call that should be implemented if you are calling getNotificationCountFromRemote:YES (Deprecated: Deprecated in SDK version 6.1.0.)
- (void)didReceiveNotificationCount:(NSInteger)count
Parameters
count |
Returns the number of unread messages for the ongoing conversation Available in SDK version 5.0.0 or later |
---|
Discussion
Optional delegate method call that should be implemented if you are calling getNotificationCountFromRemote:YES
Declared In
HelpshiftSupport.h
– helpshiftSupportSessionHasBegun
Optional delegate method that is called when the a Helpshift session begins.
- (void)helpshiftSupportSessionHasBegun
Discussion
Optional delegate method that is called when the a Helpshift session begins.
Helpshift session is any Helpshift support screen opened via showFAQ:, showConversation: or other API calls. Whenever one of these APIs launches a view on screen, this method is invoked.
Available in SDK version 5.0.0 or later
Declared In
HelpshiftSupport.h
– helpshiftSupportSessionHasEnded
Optional delegate method that is called when the Helpshift session ends.
- (void)helpshiftSupportSessionHasEnded
Discussion
Optional delegate method that is called when the Helpshift session ends.
Helpshift session is any Helpshift support screen opened via showSupport: or other API calls. Whenever the user closes that support screen and returns back to the app this method is invoked.
Available in SDK version 5.0.0 or later
Declared In
HelpshiftSupport.h
– didReceiveInAppNotificationWithMessageCount:
Optional delegate method that is called when a Helpshift inapp notification arrives and is shown
- (void)didReceiveInAppNotificationWithMessageCount:(NSInteger)count
Parameters
count |
Returns the number of messages that has arrived via inapp notification. Available in SDK version 5.0.0 or later |
---|
Discussion
Optional delegate method that is called when a Helpshift inapp notification arrives and is shown
Declared In
HelpshiftSupport.h
– newConversationStartedWithMessage:
Optional delegate method that is called when new conversation get started via any Helpshift API Ex:- showFaq:, showConversation:,etc
- (void)newConversationStartedWithMessage:(NSString *)newConversationMessage
Parameters
newConversationMessage |
Return first message of new conversation. Available in SDK version 5.0.0 or later |
---|
Discussion
Optional delegate method that is called when new conversation get started via any Helpshift API Ex:- showFaq:, showConversation:,etc
Declared In
HelpshiftSupport.h
– conversationEnded
Optional delegate method that gets called when the current conversation is ended. Available in SDK version 5.10.0 or later
- (void)conversationEnded
Discussion
Optional delegate method that gets called when the current conversation is ended. Available in SDK version 5.10.0 or later
Declared In
HelpshiftSupport.h
– didCheckIfConversationActive:
Optional delegate method that gets called in response to invocation of @code [HelpshiftSupport checkIfConversationActive] @endcode
- (void)didCheckIfConversationActive:(BOOL)isActive
Parameters
isActive |
BOOL that indicates a conversation is active or not |
---|
Availability
Available in SDK version 6.1.0 or later
Discussion
Optional delegate method that gets called in response to invocation of @code [HelpshiftSupport checkIfConversationActive] @endcode
Declared In
HelpshiftSupport.h
– userRepliedToConversationWithMessage:
Optional delegate method that is called when user reply on current open conversation via any Helpshift API Ex:- showFaq:, showConversation:, etc
- (void)userRepliedToConversationWithMessage:(NSString *)newMessage
Parameters
newMessage |
Return reply message on open conversation. Available in SDK version 5.0.0 or later |
---|
Discussion
Optional delegate method that is called when user reply on current open conversation via any Helpshift API Ex:- showFaq:, showConversation:, etc
Declared In
HelpshiftSupport.h
– userCompletedCustomerSatisfactionSurvey:withFeedback:
Optional delegate method that is called when user complete customer satisfaction survey after issue getting resolved.
- (void)userCompletedCustomerSatisfactionSurvey:(NSInteger)rating withFeedback:(NSString *)feedback
Parameters
rating |
Return the rating of customer satisfaction survey. |
---|---|
feedback |
Return text which user added in customer satisfaction survey. Available in SDK version 5.0.0 or later. |
Discussion
Optional delegate method that is called when user complete customer satisfaction survey after issue getting resolved.
Declared In
HelpshiftSupport.h
– displayAttachmentFileAtLocation:onViewController:
Optional delegate method that is called when the user taps an downloaded attachment file to view it.
- (BOOL)displayAttachmentFileAtLocation:(NSURL *)fileLocation onViewController:(UIViewController *)parentViewController
Parameters
fileLocation |
Returns the location on the downloaded attachment file. |
---|---|
parentViewController |
Returns SDK’s top view controller that the app can use to present its view. Available in SDK version 5.0.0 or later |
Return Value
If the app chooses to display the attachment file itself, return true If the app does not wish to handle the attachment, return false. In this case, the SDK will display the attachment
Discussion
Optional delegate method that is called when the user taps an downloaded attachment file to view it.
Declared In
HelpshiftSupport.h
– configForFAQViaSearch
Optional delegate method that gets called when the user clicks on a search entry corresponding to your application’s FAQs in CoreSpotlight search.
- (NSDictionary *)configForFAQViaSearch
Return Value
Dictionary with all the config options that the developer wants to pass to the showSingleFAQ API call. Available in SDK version 5.1.0 or later.
Discussion
Optional delegate method that gets called when the user clicks on a search entry corresponding to your application’s FAQs in CoreSpotlight search.
Declared In
HelpshiftSupport.h
– didCreateDynamicForm:
Optional delegate method that gets called in response to invocation @code [HelpshiftSupport requestDynamicFormWithTitle:andFlows:] @endcode
- (void)didCreateDynamicForm:(UINavigationController *)form
Parameters
form |
The dynamic form that was requested. Can be nil in case of invalid title or flow |
---|
Availability
Availalbe in SDK version 6.1.0 or later
Discussion
Optional delegate method that gets called in response to invocation @code [HelpshiftSupport requestDynamicFormWithTitle:andFlows:] @endcode
Declared In
HelpshiftSupport.h