Package com.zendesk.sdk.support
Interface SupportMvp.View
-
- All Known Implementing Classes:
- SupportActivity
- Enclosing interface:
- SupportMvp
public static interface SupportMvp.View
Defines behaviour for view operations
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
clearSearchResults()
Clears any currently shown search results from the view.void
dismissError()
Dismiss the error Snackbar if it is currently displayed.void
exitActivity()
Exits the activity immediatelyContext
getContext()
Gets the View's context.void
hideLoadingState()
Hides the loading stateboolean
isShowingHelp()
Tells whether the view is currently showing the Help Center, or Search results.void
showContactUsButton()
Shows the contact us button as a FABvoid
showContactZendesk()
Shows the contact Zendesk componentvoid
showError(int errorMessageId)
Shows a Snackbar with an error messagevoid
showErrorWithRetry(SupportMvp.ErrorType errorType, RetryAction action)
Shows a snackbar with an error message and a retry actionvoid
showHelp(SupportUiConfig supportUiConfig)
Shows Help for the given SDK UI configuration.void
showLoadingState()
Shows a loading statevoid
showRequestList()
Shows the list of requests that the user has createdvoid
showSearchResults(java.util.List<SearchArticle> searchArticles, java.lang.String query)
Shows Help search results for the given query text
-
-
-
Method Detail
-
showContactUsButton
void showContactUsButton()
Shows the contact us button as a FAB
-
showHelp
void showHelp(SupportUiConfig supportUiConfig)
Shows Help for the given SDK UI configuration.- Parameters:
supportUiConfig
- The SupportUiConfig containing the category and section IDs, label names, and configuration flags to be used in displaying the UI.
-
showSearchResults
void showSearchResults(java.util.List<SearchArticle> searchArticles, java.lang.String query)
Shows Help search results for the given query text- Parameters:
searchArticles
- The List of articles returned for the searchquery
- The query text that was used in the search
-
clearSearchResults
void clearSearchResults()
Clears any currently shown search results from the view.
-
showLoadingState
void showLoadingState()
Shows a loading state
-
hideLoadingState
void hideLoadingState()
Hides the loading state
-
showRequestList
void showRequestList()
Shows the list of requests that the user has created
-
showContactZendesk
void showContactZendesk()
Shows the contact Zendesk component
-
showErrorWithRetry
void showErrorWithRetry(SupportMvp.ErrorType errorType, RetryAction action)
Shows a snackbar with an error message and a retry action- Parameters:
errorType
- The type of error to display a message foraction
- The retry action to perform
-
showError
void showError(int errorMessageId)
Shows a Snackbar with an error message- Parameters:
errorMessageId
- The string resource ID to display
-
dismissError
void dismissError()
Dismiss the error Snackbar if it is currently displayed.
-
getContext
Context getContext()
Gets the View's context.- Returns:
- The Context of the View implementation.
-
isShowingHelp
boolean isShowingHelp()
Tells whether the view is currently showing the Help Center, or Search results. While this is the kind of logical decision normally calculated by the presenter, in this case, with state changes etc, the view is the ultimate source of truth.- Returns:
- true if the currently displayed view is the Help Center, false if it's search results.
-
exitActivity
void exitActivity()
Exits the activity immediately
-
-