close

Filter

loading table of contents...

Studio Developer Manual / Version 2110

Table Of Contents

9.28.4 Error handling

Feedback Hub offers the possibility to send error codes and arguments to the client, where they can be localized to error messages (please see Section 9.28.3, “Localization”). The arguments are of Type String and provide the possibility to create dynamic error messages. In the implementations of the ContentFeedbackProviderFactory and the ContentFeedbackProvider, errors that should result in a specific error message to the client need to be wrapped into a FeedbackHubException, with a specific FeedbackHubErrorCode and an optional list of arguments. This exception will be caught by the framework and the code will be passed to the client.

Note

Note

If errors occur which result in an exception not of Type FeedbackHubException they will be caught by the framework and delivered to the client with a general error message.

In your custom Feedback Hub adapter, you need to use the following naming pattern in order to localize the error messages: <groupId>_error_<ErrorCode_of_CustomFeedbackHubErrorCode_Implementation>. If you have for example a CustomFeedbackHubErrorCode Enum which is implementing FeedbackHubErrorCode with the value ERROR_CUSTOM and the groupId myAdapter, the localization would be: myAdapter_error_ERROR_CUSTOM

Within the localization value you can use placeholders like {0}, {1} etc. that are filled with the arguments that were passed to the FeedbackHubException. The arguments occur in the same order as they were passed to the exception.

Note

Note

The first argument is always the ID of the binding. It is set by the framework and can be referenced with {0}!

An error appears in the Feedback Hub window in a red NagBar at the bottom of the Window. (Error Appearance is shown inSection 4.7.8, “Getting Keyword Recommendations” in Studio User Manual)

Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.